Command

Type: object

MegaLinter configuration file

 No Additional Properties

root ACTION_ACTIONLINT_ARGUMENTS

ACTION_ACTIONLINT: Custom arguments

Type: array of string or string

ACTION_ACTIONLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_ARGUMENTS ACTION_ACTIONLINT_ARGUMENTS items
Type: string

root ACTION_ACTIONLINT_CLI_EXECUTABLE

ACTION_ACTIONLINT: CLI Executable

Type: array of string Default: [["actionlint"]]

ACTION_ACTIONLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_CLI_EXECUTABLE ACTION_ACTIONLINT_CLI_EXECUTABLE items
Type: string

root ACTION_ACTIONLINT_CLI_LINT_MODE

ACTION_ACTIONLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

ACTION_ACTIONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS

ACTION_ACTIONLINT: Custom remove arguments

Type: array of string or string

ACTION_ACTIONLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root ACTION_ACTIONLINT_CONFIG_FILE

ACTION_ACTIONLINT: Custom config file name

Type: string Default: "actionlint.yml"

ACTION_ACTIONLINT: User custom config file name if different from default

root ACTION_ACTIONLINT_DIRECTORY

ACTION_ACTIONLINT: Directory containing ACTION files

Type: string Default: ".github/workflows"

Directory that must be found to activate linter. Use value "any" to always activate

root ACTION_ACTIONLINT_DISABLE_ERRORS

ACTION_ACTIONLINT: Disable errors

Type: boolean Default: false

ACTIONACTIONLINT: If true, ACTIONACTIONLINT doesn't make MegaLinter fail even if errors are found

root ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN

ACTION_ACTIONLINT: Maximum number of errors allowed

Type: number Default: 0

ACTIONACTIONLINT: If the number of errors found is less than this value, ACTIONACTIONLINT doesn't make MegaLinter fail

root ACTION_ACTIONLINT_FILE_EXTENSIONS

ACTION_ACTIONLINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

ACTION_ACTIONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_FILE_EXTENSIONS ACTION_ACTIONLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root ACTION_ACTIONLINT_FILE_NAMES_REGEX

ACTION_ACTIONLINT: Matching file name regexes

Type: array of string Default: []

ACTION_ACTIONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_FILE_NAMES_REGEX ACTION_ACTIONLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE

ACTION_ACTIONLINT: Excluding Regex

Type: string

ACTION_ACTIONLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE

ACTION_ACTIONLINT: Including Regex

Type: string

ACTION_ACTIONLINT: Custom regex including filter: only files matching this regex will be linted

root ACTION_ACTIONLINT_POST_COMMANDS

ACTION_ACTIONLINT: Post-run commands

Type: array

ACTIONACTIONLINT: Define bash commands to run after running ACTIONACTIONLINT

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_POST_COMMANDS Command

Command

Type: object

Command information

root ACTION_ACTIONLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ACTION_ACTIONLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ACTION_ACTIONLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ACTION_ACTIONLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root ACTION_ACTIONLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ACTION_ACTIONLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ACTION_ACTIONLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ACTION_ACTIONLINT_PRE_COMMANDS

ACTION_ACTIONLINT: Pre-run commands

Type: array

ACTIONACTIONLINT: Define bash commands to run before running ACTIONACTIONLINT

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root ACTION_ACTIONLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ACTION_ACTIONLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ACTION_ACTIONLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ACTION_ACTIONLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ACTION_ACTIONLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ACTION_ACTIONLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ACTION_ACTIONLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ACTION_ACTIONLINT_RULES_PATH

ACTION_ACTIONLINT: Custom config file path

Type: string

ACTION_ACTIONLINT: Path where to find linter configuration file

root ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES

ACTION_ACTIONLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ACTION_ACTIONLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES items
Type: string

root ACTION_FILTER_REGEX_EXCLUDE

Excluding regex filter for ACTION descriptor

Type: string

ACTION: Custom regex excluding filter: files matching this regex will NOT be linted

root ACTION_FILTER_REGEX_INCLUDE

Including regex filter for ACTION descriptor

Type: string

ACTION: Custom regex including filter: only files matching this regex will be linted

root ACTION_POST_COMMANDS

Post commands for ACTION descriptor

Type: array

ACTION: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root ACTION_POST_COMMANDS Command

Command

Type: object

Command information

root ACTION_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ACTION_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ACTION_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ACTION_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ACTION_POST_COMMANDS Command output_variables output_variables items
Type: string

root ACTION_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ACTION_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ACTION_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ACTION_PRE_COMMANDS

Pre commands for ACTION descriptor

Type: array

ACTION: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root ACTION_PRE_COMMANDS Command

Command

Type: object

Command information

root ACTION_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ACTION_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ACTION_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ACTION_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ACTION_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ACTION_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ACTION_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ACTION_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ADDITIONAL_EXCLUDED_DIRECTORIES

Additional excluded directories

Type: array of string

List of additional excluded directory basenames to add to MegaLinter default excluded directories. They are excluded at any nested level.

 No Additional Items

Each item of this array must be:

root ADDITIONAL_EXCLUDED_DIRECTORIES ADDITIONAL_EXCLUDED_DIRECTORIES items
Type: string

Example:

[
    "test"
]

root ANSIBLE_ANSIBLE_LINT_ARGUMENTS

ANSIBLE_ANSIBLE_LINT: Custom arguments

Type: array of string or string

ANSIBLEANSIBLELINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_ARGUMENTS ANSIBLE_ANSIBLE_LINT_ARGUMENTS items
Type: string

root ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE

ANSIBLE_ANSIBLE_LINT: CLI Executable

Type: array of string Default: [["ansible-lint"]]

ANSIBLEANSIBLELINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE items
Type: string

root ANSIBLE_ANSIBLE_LINT_CLI_LINT_MODE

ANSIBLE_ANSIBLE_LINT: CLI lint mode

Type: enum (of string) Default: "project"

ANSIBLEANSIBLELINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS

ANSIBLE_ANSIBLE_LINT: Custom remove arguments

Type: array of string or string

ANSIBLEANSIBLELINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root ANSIBLE_ANSIBLE_LINT_CONFIG_FILE

ANSIBLE_ANSIBLE_LINT: Custom config file name

Type: string Default: ".ansible-lint"

ANSIBLEANSIBLELINT: User custom config file name if different from default

root ANSIBLE_ANSIBLE_LINT_DIRECTORY

ANSIBLE_ANSIBLE_LINT: Directory containing ANSIBLE files

Type: string Default: "ansible"

Directory that must be found to activate linter. Use value "any" to always activate

root ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS

ANSIBLE_ANSIBLE_LINT: Disable errors

Type: boolean Default: false

ANSIBLEANSIBLELINT: If true, ANSIBLEANSIBLELINT doesn't make MegaLinter fail even if errors are found

root ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN

ANSIBLE_ANSIBLE_LINT: Maximum number of errors allowed

Type: number Default: 0

ANSIBLEANSIBLELINT: If the number of errors found is less than this value, ANSIBLEANSIBLELINT doesn't make MegaLinter fail

root ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS

ANSIBLE_ANSIBLE_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

ANSIBLEANSIBLELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX

ANSIBLE_ANSIBLE_LINT: Matching file name regexes

Type: array of string Default: []

ANSIBLEANSIBLELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS

ANSIBLE_ANSIBLE_LINT: Post-run commands

Type: array

ANSIBLEANSIBLELINT: Define bash commands to run after running ANSIBLEANSIBLELINT

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS

ANSIBLE_ANSIBLE_LINT: Pre-run commands

Type: array

ANSIBLEANSIBLELINT: Define bash commands to run before running ANSIBLEANSIBLELINT

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ANSIBLE_ANSIBLE_LINT_RULES_PATH

ANSIBLE_ANSIBLE_LINT: Custom config file path

Type: string

ANSIBLEANSIBLELINT: Path where to find linter configuration file

root ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES

ANSIBLE_ANSIBLE_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ANSIBLEANSIBLELINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root ANSIBLE_DIRECTORY

ANSIBLE_DIRECTORY: Directory containing ANSIBLE files

Type: string Default: "ansible"

root ANSIBLE_FILTER_REGEX_EXCLUDE

Excluding regex filter for ANSIBLE descriptor

Type: string

ANSIBLE: Custom regex excluding filter: files matching this regex will NOT be linted

root ANSIBLE_FILTER_REGEX_INCLUDE

Including regex filter for ANSIBLE descriptor

Type: string

ANSIBLE: Custom regex including filter: only files matching this regex will be linted

root ANSIBLE_POST_COMMANDS

Post commands for ANSIBLE descriptor

Type: array

ANSIBLE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root ANSIBLE_POST_COMMANDS Command

Command

Type: object

Command information

root ANSIBLE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ANSIBLE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ANSIBLE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ANSIBLE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ANSIBLE_POST_COMMANDS Command output_variables output_variables items
Type: string

root ANSIBLE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ANSIBLE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ANSIBLE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ANSIBLE_PRE_COMMANDS

Pre commands for ANSIBLE descriptor

Type: array

ANSIBLE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root ANSIBLE_PRE_COMMANDS Command

Command

Type: object

Command information

root ANSIBLE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ANSIBLE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ANSIBLE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ANSIBLE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ANSIBLE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ANSIBLE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ANSIBLE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ANSIBLE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root API_FILTER_REGEX_EXCLUDE

Excluding regex filter for API descriptor

Type: string

API: Custom regex excluding filter: files matching this regex will NOT be linted

root API_FILTER_REGEX_INCLUDE

Including regex filter for API descriptor

Type: string

API: Custom regex including filter: only files matching this regex will be linted

root API_POST_COMMANDS

Post commands for API descriptor

Type: array

API: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root API_POST_COMMANDS Command

Command

Type: object

Command information

root API_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root API_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root API_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root API_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root API_POST_COMMANDS Command output_variables output_variables items
Type: string

root API_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root API_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root API_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root API_PRE_COMMANDS

Pre commands for API descriptor

Type: array

API: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root API_PRE_COMMANDS Command

Command

Type: object

Command information

root API_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root API_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root API_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root API_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root API_PRE_COMMANDS Command output_variables output_variables items
Type: string

root API_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root API_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root API_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root API_SPECTRAL_ARGUMENTS

API_SPECTRAL: Custom arguments

Type: array of string or string

API_SPECTRAL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_ARGUMENTS API_SPECTRAL_ARGUMENTS items
Type: string

root API_SPECTRAL_CLI_EXECUTABLE

API_SPECTRAL: CLI Executable

Type: array of string Default: [["spectral"]]

API_SPECTRAL: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_CLI_EXECUTABLE API_SPECTRAL_CLI_EXECUTABLE items
Type: string

root API_SPECTRAL_CLI_LINT_MODE

API_SPECTRAL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

API_SPECTRAL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root API_SPECTRAL_COMMAND_REMOVE_ARGUMENTS

API_SPECTRAL: Custom remove arguments

Type: array of string or string

API_SPECTRAL: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_COMMAND_REMOVE_ARGUMENTS API_SPECTRAL_COMMAND_REMOVE_ARGUMENTS items
Type: string

root API_SPECTRAL_CONFIG_FILE

API_SPECTRAL: Custom config file name

Type: string Default: ".spectral.yaml"

API_SPECTRAL: User custom config file name if different from default

root API_SPECTRAL_DISABLE_ERRORS

API_SPECTRAL: Disable errors

Type: boolean Default: false

APISPECTRAL: If true, APISPECTRAL doesn't make MegaLinter fail even if errors are found

root API_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN

API_SPECTRAL: Maximum number of errors allowed

Type: number Default: 0

APISPECTRAL: If the number of errors found is less than this value, APISPECTRAL doesn't make MegaLinter fail

root API_SPECTRAL_FILE_EXTENSIONS

API_SPECTRAL: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

API_SPECTRAL: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_FILE_EXTENSIONS API_SPECTRAL_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root API_SPECTRAL_FILE_NAMES_REGEX

API_SPECTRAL: Matching file name regexes

Type: array of string Default: []

API_SPECTRAL: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_FILE_NAMES_REGEX API_SPECTRAL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root API_SPECTRAL_FILTER_REGEX_EXCLUDE

API_SPECTRAL: Excluding Regex

Type: string

API_SPECTRAL: Custom regex excluding filter: files matching this regex will NOT be linted

root API_SPECTRAL_FILTER_REGEX_INCLUDE

API_SPECTRAL: Including Regex

Type: string

API_SPECTRAL: Custom regex including filter: only files matching this regex will be linted

root API_SPECTRAL_POST_COMMANDS

API_SPECTRAL: Post-run commands

Type: array

APISPECTRAL: Define bash commands to run after running APISPECTRAL

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_POST_COMMANDS Command

Command

Type: object

Command information

root API_SPECTRAL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root API_SPECTRAL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root API_SPECTRAL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root API_SPECTRAL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_POST_COMMANDS Command output_variables output_variables items
Type: string

root API_SPECTRAL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root API_SPECTRAL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root API_SPECTRAL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root API_SPECTRAL_PRE_COMMANDS

API_SPECTRAL: Pre-run commands

Type: array

APISPECTRAL: Define bash commands to run before running APISPECTRAL

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_PRE_COMMANDS Command

Command

Type: object

Command information

root API_SPECTRAL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root API_SPECTRAL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root API_SPECTRAL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root API_SPECTRAL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root API_SPECTRAL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root API_SPECTRAL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root API_SPECTRAL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root API_SPECTRAL_RULES_PATH

API_SPECTRAL: Custom config file path

Type: string

API_SPECTRAL: Path where to find linter configuration file

root API_SPECTRAL_UNSECURED_ENV_VARIABLES

API_SPECTRAL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling API_SPECTRAL and its pre/post commands

 No Additional Items

Each item of this array must be:

root API_SPECTRAL_UNSECURED_ENV_VARIABLES API_SPECTRAL_UNSECURED_ENV_VARIABLES items
Type: string

root APPLY_FIXES

Apply linters formatting and auto-fixes

Type: array or string Default: "none"

'all' to apply formatting and auto-fixes of all linters, or a list of linter keys

 No Additional Items

Each item of this array must be:

root APPLY_FIXES enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Examples:

"all"

"none"

[
    "JAVASCRIPT_ES",
    "MARKDOWN_MARKDOWNLINT"
]

root ARM_ARM_TTK_ARGUMENTS

ARM_ARM_TTK: Custom arguments

Type: array of string or string

ARMARMTTK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_ARGUMENTS ARM_ARM_TTK_ARGUMENTS items
Type: string

root ARM_ARM_TTK_CLI_EXECUTABLE

ARM_ARM_TTK: CLI Executable

Type: array of string Default: [["arm-ttk"]]

ARMARMTTK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_CLI_EXECUTABLE ARM_ARM_TTK_CLI_EXECUTABLE items
Type: string

root ARM_ARM_TTK_CLI_LINT_MODE

ARM_ARM_TTK: CLI lint mode

Type: enum (of string) Default: "file"

ARMARMTTK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS

ARM_ARM_TTK: Custom remove arguments

Type: array of string or string

ARMARMTTK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root ARM_ARM_TTK_CONFIG_FILE

ARM_ARM_TTK: Custom config file name

Type: string Default: ".arm-ttk.psd1"

ARMARMTTK: User custom config file name if different from default

root ARM_ARM_TTK_DISABLE_ERRORS

ARM_ARM_TTK: Disable errors

Type: boolean Default: false

ARMARMTTK: If true, ARMARMTTK doesn't make MegaLinter fail even if errors are found

root ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN

ARM_ARM_TTK: Maximum number of errors allowed

Type: number Default: 0

ARMARMTTK: If the number of errors found is less than this value, ARMARMTTK doesn't make MegaLinter fail

root ARM_ARM_TTK_FILE_EXTENSIONS

ARM_ARM_TTK: Matching files extensions

Type: array of string Default: [".json"]

ARMARMTTK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_FILE_EXTENSIONS ARM_ARM_TTK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root ARM_ARM_TTK_FILE_NAMES_REGEX

ARM_ARM_TTK: Matching file name regexes

Type: array of string Default: []

ARMARMTTK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_FILE_NAMES_REGEX ARM_ARM_TTK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root ARM_ARM_TTK_FILTER_REGEX_EXCLUDE

ARM_ARM_TTK: Excluding Regex

Type: string

ARMARMTTK: Custom regex excluding filter: files matching this regex will NOT be linted

root ARM_ARM_TTK_FILTER_REGEX_INCLUDE

ARM_ARM_TTK: Including Regex

Type: string

ARMARMTTK: Custom regex including filter: only files matching this regex will be linted

root ARM_ARM_TTK_POST_COMMANDS

ARM_ARM_TTK: Post-run commands

Type: array

ARMARMTTK: Define bash commands to run after running ARMARMTTK

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_POST_COMMANDS Command

Command

Type: object

Command information

root ARM_ARM_TTK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ARM_ARM_TTK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ARM_ARM_TTK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ARM_ARM_TTK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_POST_COMMANDS Command output_variables output_variables items
Type: string

root ARM_ARM_TTK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ARM_ARM_TTK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ARM_ARM_TTK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ARM_ARM_TTK_PRE_COMMANDS

ARM_ARM_TTK: Pre-run commands

Type: array

ARMARMTTK: Define bash commands to run before running ARMARMTTK

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_PRE_COMMANDS Command

Command

Type: object

Command information

root ARM_ARM_TTK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ARM_ARM_TTK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ARM_ARM_TTK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ARM_ARM_TTK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ARM_ARM_TTK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ARM_ARM_TTK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ARM_ARM_TTK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ARM_ARM_TTK_RULES_PATH

ARM_ARM_TTK: Custom config file path

Type: string

ARMARMTTK: Path where to find linter configuration file

root ARM_ARM_TTK_UNSECURED_ENV_VARIABLES

ARM_ARM_TTK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ARMARMTTK and its pre/post commands

 No Additional Items

Each item of this array must be:

root ARM_ARM_TTK_UNSECURED_ENV_VARIABLES ARM_ARM_TTK_UNSECURED_ENV_VARIABLES items
Type: string

root ARM_FILTER_REGEX_EXCLUDE

Excluding regex filter for ARM descriptor

Type: string

ARM: Custom regex excluding filter: files matching this regex will NOT be linted

root ARM_FILTER_REGEX_INCLUDE

Including regex filter for ARM descriptor

Type: string

ARM: Custom regex including filter: only files matching this regex will be linted

root ARM_POST_COMMANDS

Post commands for ARM descriptor

Type: array

ARM: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root ARM_POST_COMMANDS Command

Command

Type: object

Command information

root ARM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ARM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ARM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ARM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ARM_POST_COMMANDS Command output_variables output_variables items
Type: string

root ARM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ARM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ARM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ARM_PRE_COMMANDS

Pre commands for ARM descriptor

Type: array

ARM: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root ARM_PRE_COMMANDS Command

Command

Type: object

Command information

root ARM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ARM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ARM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ARM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ARM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ARM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ARM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ARM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root AZURE_COMMENT_REPORTER

Activate Azure PR Comments reporter

Type: boolean Default: true

Posts MegaLinter results summary in the comments of the related pull request (if existing)

root BASH_EXEC_ARGUMENTS

BASH_EXEC: Custom arguments

Type: array of string or string

BASH_EXEC: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root BASH_EXEC_ARGUMENTS BASH_EXEC_ARGUMENTS items
Type: string

root BASH_EXEC_CLI_EXECUTABLE

BASH_EXEC: CLI Executable

Type: array of string Default: [["bash-exec"]]

BASH_EXEC: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root BASH_EXEC_CLI_EXECUTABLE BASH_EXEC_CLI_EXECUTABLE items
Type: string

root BASH_EXEC_CLI_LINT_MODE

BASH_EXEC: CLI lint mode

Type: enum (of string) Default: "file"

BASH_EXEC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root BASH_EXEC_COMMAND_REMOVE_ARGUMENTS

BASH_EXEC: Custom remove arguments

Type: array of string or string

BASH_EXEC: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root BASH_EXEC_COMMAND_REMOVE_ARGUMENTS BASH_EXEC_COMMAND_REMOVE_ARGUMENTS items
Type: string

root BASH_EXEC_DISABLE_ERRORS

BASH_EXEC: Disable errors

Type: boolean Default: false

BASHEXEC: If true, BASHEXEC doesn't make MegaLinter fail even if errors are found

root BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN

BASH_EXEC: Maximum number of errors allowed

Type: number Default: 0

BASHEXEC: If the number of errors found is less than this value, BASHEXEC doesn't make MegaLinter fail

root BASH_EXEC_FILE_EXTENSIONS

BASH_EXEC: Matching files extensions

Type: array of string Default: ["", ".sh", ".bash", ".dash", ".ksh"]

BASH_EXEC: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_EXEC_FILE_EXTENSIONS BASH_EXEC_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root BASH_EXEC_FILE_NAMES_REGEX

BASH_EXEC: Matching file name regexes

Type: array of string Default: []

BASH_EXEC: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_EXEC_FILE_NAMES_REGEX BASH_EXEC_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root BASH_EXEC_FILTER_REGEX_EXCLUDE

BASH_EXEC: Excluding Regex

Type: string

BASH_EXEC: Custom regex excluding filter: files matching this regex will NOT be linted

root BASH_EXEC_FILTER_REGEX_INCLUDE

BASH_EXEC: Including Regex

Type: string

BASH_EXEC: Custom regex including filter: only files matching this regex will be linted

root BASH_EXEC_POST_COMMANDS

BASH_EXEC: Post-run commands

Type: array

BASHEXEC: Define bash commands to run after running BASHEXEC

 No Additional Items

Each item of this array must be:

root BASH_EXEC_POST_COMMANDS Command

Command

Type: object

Command information

root BASH_EXEC_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_EXEC_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_EXEC_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_EXEC_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_EXEC_POST_COMMANDS Command output_variables output_variables items
Type: string

root BASH_EXEC_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_EXEC_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_EXEC_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_EXEC_PRE_COMMANDS

BASH_EXEC: Pre-run commands

Type: array

BASHEXEC: Define bash commands to run before running BASHEXEC

 No Additional Items

Each item of this array must be:

root BASH_EXEC_PRE_COMMANDS Command

Command

Type: object

Command information

root BASH_EXEC_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_EXEC_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_EXEC_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_EXEC_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_EXEC_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BASH_EXEC_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_EXEC_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_EXEC_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_EXEC_UNSECURED_ENV_VARIABLES

BASH_EXEC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling BASH_EXEC and its pre/post commands

 No Additional Items

Each item of this array must be:

root BASH_EXEC_UNSECURED_ENV_VARIABLES BASH_EXEC_UNSECURED_ENV_VARIABLES items
Type: string

root BASH_FILTER_REGEX_EXCLUDE

Excluding regex filter for BASH descriptor

Type: string

BASH: Custom regex excluding filter: files matching this regex will NOT be linted

root BASH_FILTER_REGEX_INCLUDE

Including regex filter for BASH descriptor

Type: string

BASH: Custom regex including filter: only files matching this regex will be linted

root BASH_POST_COMMANDS

Post commands for BASH descriptor

Type: array

BASH: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root BASH_POST_COMMANDS Command

Command

Type: object

Command information

root BASH_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_POST_COMMANDS Command output_variables output_variables items
Type: string

root BASH_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_PRE_COMMANDS

Pre commands for BASH descriptor

Type: array

BASH: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root BASH_PRE_COMMANDS Command

Command

Type: object

Command information

root BASH_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BASH_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_SHELLCHECK_ARGUMENTS

BASH_SHELLCHECK: Custom arguments

Type: array of string or string

BASH_SHELLCHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_ARGUMENTS BASH_SHELLCHECK_ARGUMENTS items
Type: string

root BASH_SHELLCHECK_CLI_EXECUTABLE

BASH_SHELLCHECK: CLI Executable

Type: array of string Default: [["shellcheck"]]

BASH_SHELLCHECK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_CLI_EXECUTABLE BASH_SHELLCHECK_CLI_EXECUTABLE items
Type: string

root BASH_SHELLCHECK_CLI_LINT_MODE

BASH_SHELLCHECK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

BASH_SHELLCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS

BASH_SHELLCHECK: Custom remove arguments

Type: array of string or string

BASH_SHELLCHECK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root BASH_SHELLCHECK_DISABLE_ERRORS

BASH_SHELLCHECK: Disable errors

Type: boolean Default: false

BASHSHELLCHECK: If true, BASHSHELLCHECK doesn't make MegaLinter fail even if errors are found

root BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN

BASH_SHELLCHECK: Maximum number of errors allowed

Type: number Default: 0

BASHSHELLCHECK: If the number of errors found is less than this value, BASHSHELLCHECK doesn't make MegaLinter fail

root BASH_SHELLCHECK_FILE_EXTENSIONS

BASH_SHELLCHECK: Matching files extensions

Type: array of string Default: ["", ".sh", ".bash", ".dash", ".ksh"]

BASH_SHELLCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_FILE_EXTENSIONS BASH_SHELLCHECK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root BASH_SHELLCHECK_FILE_NAMES_REGEX

BASH_SHELLCHECK: Matching file name regexes

Type: array of string Default: []

BASH_SHELLCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_FILE_NAMES_REGEX BASH_SHELLCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE

BASH_SHELLCHECK: Excluding Regex

Type: string

BASH_SHELLCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

root BASH_SHELLCHECK_FILTER_REGEX_INCLUDE

BASH_SHELLCHECK: Including Regex

Type: string

BASH_SHELLCHECK: Custom regex including filter: only files matching this regex will be linted

root BASH_SHELLCHECK_POST_COMMANDS

BASH_SHELLCHECK: Post-run commands

Type: array

BASHSHELLCHECK: Define bash commands to run after running BASHSHELLCHECK

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_POST_COMMANDS Command

Command

Type: object

Command information

root BASH_SHELLCHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_SHELLCHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_SHELLCHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_SHELLCHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root BASH_SHELLCHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_SHELLCHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_SHELLCHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_SHELLCHECK_PRE_COMMANDS

BASH_SHELLCHECK: Pre-run commands

Type: array

BASHSHELLCHECK: Define bash commands to run before running BASHSHELLCHECK

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root BASH_SHELLCHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_SHELLCHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_SHELLCHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_SHELLCHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BASH_SHELLCHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_SHELLCHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_SHELLCHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES

BASH_SHELLCHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling BASH_SHELLCHECK and its pre/post commands

 No Additional Items

Each item of this array must be:

root BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES items
Type: string

root BASH_SHFMT_ARGUMENTS

BASH_SHFMT: Custom arguments

Type: array of string or string

BASH_SHFMT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_ARGUMENTS BASH_SHFMT_ARGUMENTS items
Type: string

root BASH_SHFMT_CLI_EXECUTABLE

BASH_SHFMT: CLI Executable

Type: array of string Default: [["shfmt"]]

BASH_SHFMT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_CLI_EXECUTABLE BASH_SHFMT_CLI_EXECUTABLE items
Type: string

root BASH_SHFMT_CLI_LINT_MODE

BASH_SHFMT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

BASH_SHFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS

BASH_SHFMT: Custom remove arguments

Type: array of string or string

BASH_SHFMT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root BASH_SHFMT_DISABLE_ERRORS

BASH_SHFMT: Disable errors

Type: boolean Default: false

BASHSHFMT: If true, BASHSHFMT doesn't make MegaLinter fail even if errors are found

root BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN

BASH_SHFMT: Maximum number of errors allowed

Type: number Default: 0

BASHSHFMT: If the number of errors found is less than this value, BASHSHFMT doesn't make MegaLinter fail

root BASH_SHFMT_FILE_EXTENSIONS

BASH_SHFMT: Matching files extensions

Type: array of string Default: ["", ".sh", ".bash", ".dash", ".ksh"]

BASH_SHFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_FILE_EXTENSIONS BASH_SHFMT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root BASH_SHFMT_FILE_NAMES_REGEX

BASH_SHFMT: Matching file name regexes

Type: array of string Default: []

BASH_SHFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_FILE_NAMES_REGEX BASH_SHFMT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root BASH_SHFMT_FILTER_REGEX_EXCLUDE

BASH_SHFMT: Excluding Regex

Type: string

BASH_SHFMT: Custom regex excluding filter: files matching this regex will NOT be linted

root BASH_SHFMT_FILTER_REGEX_INCLUDE

BASH_SHFMT: Including Regex

Type: string

BASH_SHFMT: Custom regex including filter: only files matching this regex will be linted

root BASH_SHFMT_POST_COMMANDS

BASH_SHFMT: Post-run commands

Type: array

BASHSHFMT: Define bash commands to run after running BASHSHFMT

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_POST_COMMANDS Command

Command

Type: object

Command information

root BASH_SHFMT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_SHFMT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_SHFMT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_SHFMT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_POST_COMMANDS Command output_variables output_variables items
Type: string

root BASH_SHFMT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_SHFMT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_SHFMT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_SHFMT_PRE_COMMANDS

BASH_SHFMT: Pre-run commands

Type: array

BASHSHFMT: Define bash commands to run before running BASHSHFMT

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_PRE_COMMANDS Command

Command

Type: object

Command information

root BASH_SHFMT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BASH_SHFMT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BASH_SHFMT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BASH_SHFMT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BASH_SHFMT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BASH_SHFMT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BASH_SHFMT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BASH_SHFMT_UNSECURED_ENV_VARIABLES

BASH_SHFMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling BASH_SHFMT and its pre/post commands

 No Additional Items

Each item of this array must be:

root BASH_SHFMT_UNSECURED_ENV_VARIABLES BASH_SHFMT_UNSECURED_ENV_VARIABLES items
Type: string

root BICEP_BICEP_LINTER_ARGUMENTS

BICEP_BICEP_LINTER: Custom arguments

Type: array of string or string

BICEPBICEPLINTER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_ARGUMENTS BICEP_BICEP_LINTER_ARGUMENTS items
Type: string

root BICEP_BICEP_LINTER_CLI_EXECUTABLE

BICEP_BICEP_LINTER: CLI Executable

Type: array of string Default: [["bicep"]]

BICEPBICEPLINTER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_CLI_EXECUTABLE BICEP_BICEP_LINTER_CLI_EXECUTABLE items
Type: string

root BICEP_BICEP_LINTER_CLI_LINT_MODE

BICEP_BICEP_LINTER: CLI lint mode

Type: enum (of string) Default: "file"

BICEPBICEPLINTER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS

BICEP_BICEP_LINTER: Custom remove arguments

Type: array of string or string

BICEPBICEPLINTER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root BICEP_BICEP_LINTER_DISABLE_ERRORS

BICEP_BICEP_LINTER: Disable errors

Type: boolean Default: false

BICEPBICEPLINTER: If true, BICEPBICEPLINTER doesn't make MegaLinter fail even if errors are found

root BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN

BICEP_BICEP_LINTER: Maximum number of errors allowed

Type: number Default: 0

BICEPBICEPLINTER: If the number of errors found is less than this value, BICEPBICEPLINTER doesn't make MegaLinter fail

root BICEP_BICEP_LINTER_FILE_EXTENSIONS

BICEP_BICEP_LINTER: Matching files extensions

Type: array of string Default: [".bicep"]

BICEPBICEPLINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_FILE_EXTENSIONS BICEP_BICEP_LINTER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root BICEP_BICEP_LINTER_FILE_NAMES_REGEX

BICEP_BICEP_LINTER: Matching file name regexes

Type: array of string Default: []

BICEPBICEPLINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_FILE_NAMES_REGEX BICEP_BICEP_LINTER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE

BICEP_BICEP_LINTER: Excluding Regex

Type: string

BICEPBICEPLINTER: Custom regex excluding filter: files matching this regex will NOT be linted

root BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE

BICEP_BICEP_LINTER: Including Regex

Type: string

BICEPBICEPLINTER: Custom regex including filter: only files matching this regex will be linted

root BICEP_BICEP_LINTER_POST_COMMANDS

BICEP_BICEP_LINTER: Post-run commands

Type: array

BICEPBICEPLINTER: Define bash commands to run after running BICEPBICEPLINTER

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_POST_COMMANDS Command

Command

Type: object

Command information

root BICEP_BICEP_LINTER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BICEP_BICEP_LINTER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BICEP_BICEP_LINTER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BICEP_BICEP_LINTER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_POST_COMMANDS Command output_variables output_variables items
Type: string

root BICEP_BICEP_LINTER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BICEP_BICEP_LINTER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BICEP_BICEP_LINTER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BICEP_BICEP_LINTER_PRE_COMMANDS

BICEP_BICEP_LINTER: Pre-run commands

Type: array

BICEPBICEPLINTER: Define bash commands to run before running BICEPBICEPLINTER

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_PRE_COMMANDS Command

Command

Type: object

Command information

root BICEP_BICEP_LINTER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BICEP_BICEP_LINTER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BICEP_BICEP_LINTER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BICEP_BICEP_LINTER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BICEP_BICEP_LINTER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BICEP_BICEP_LINTER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BICEP_BICEP_LINTER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES

BICEP_BICEP_LINTER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling BICEPBICEPLINTER and its pre/post commands

 No Additional Items

Each item of this array must be:

root BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES items
Type: string

root BICEP_FILTER_REGEX_EXCLUDE

Excluding regex filter for BICEP descriptor

Type: string

BICEP: Custom regex excluding filter: files matching this regex will NOT be linted

root BICEP_FILTER_REGEX_INCLUDE

Including regex filter for BICEP descriptor

Type: string

BICEP: Custom regex including filter: only files matching this regex will be linted

root BICEP_POST_COMMANDS

Post commands for BICEP descriptor

Type: array

BICEP: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root BICEP_POST_COMMANDS Command

Command

Type: object

Command information

root BICEP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BICEP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BICEP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BICEP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BICEP_POST_COMMANDS Command output_variables output_variables items
Type: string

root BICEP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BICEP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BICEP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BICEP_PRE_COMMANDS

Pre commands for BICEP descriptor

Type: array

BICEP: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root BICEP_PRE_COMMANDS Command

Command

Type: object

Command information

root BICEP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root BICEP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root BICEP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root BICEP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root BICEP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root BICEP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root BICEP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root BICEP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root BITBUCKET_COMMENT_REPORTER

Activate Bitbucket PR Comments reporter

Type: boolean Default: true

Posts Mega-Linter results summary in the comments of the related pull request (if existing)

root BITBUCKET_COMMENT_REPORTER_OVERWRITE_COMMENT

Overwrite Bitbucket Pull Request Comment

Type: boolean Default: true

Set to false to disable the overwrite of existing MegaLinter Pull Request comment in case of new run

root CLEAR_REPORT_FOLDER

Clear Report Folder

Type: boolean Default: false

Flag to clear files from report folder (usually megalinter-reports) before starting the linting process

root CLOJURE_CLJSTYLE_ARGUMENTS

CLOJURE_CLJSTYLE: Custom arguments

Type: array of string or string

CLOJURE_CLJSTYLE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_ARGUMENTS CLOJURE_CLJSTYLE_ARGUMENTS items
Type: string

root CLOJURE_CLJSTYLE_CLI_EXECUTABLE

CLOJURE_CLJSTYLE: CLI Executable

Type: array of string Default: [["cljstyle"]]

CLOJURE_CLJSTYLE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_CLI_EXECUTABLE CLOJURE_CLJSTYLE_CLI_EXECUTABLE items
Type: string

root CLOJURE_CLJSTYLE_CLI_LINT_MODE

CLOJURE_CLJSTYLE: CLI lint mode

Type: enum (of string) Default: "file"

CLOJURE_CLJSTYLE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS

CLOJURE_CLJSTYLE: Custom remove arguments

Type: array of string or string

CLOJURE_CLJSTYLE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CLOJURE_CLJSTYLE_CONFIG_FILE

CLOJURE_CLJSTYLE: Custom config file name

Type: string Default: ".cljstyle"

CLOJURE_CLJSTYLE: User custom config file name if different from default

root CLOJURE_CLJSTYLE_DISABLE_ERRORS

CLOJURE_CLJSTYLE: Disable errors

Type: boolean Default: false

CLOJURECLJSTYLE: If true, CLOJURECLJSTYLE doesn't make MegaLinter fail even if errors are found

root CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN

CLOJURE_CLJSTYLE: Maximum number of errors allowed

Type: number Default: 0

CLOJURECLJSTYLE: If the number of errors found is less than this value, CLOJURECLJSTYLE doesn't make MegaLinter fail

root CLOJURE_CLJSTYLE_FILE_EXTENSIONS

CLOJURE_CLJSTYLE: Matching files extensions

Type: array of string Default: [".clj", ".cljs", ".cljc", ".edn"]

CLOJURE_CLJSTYLE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_FILE_EXTENSIONS CLOJURE_CLJSTYLE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CLOJURE_CLJSTYLE_FILE_NAMES_REGEX

CLOJURE_CLJSTYLE: Matching file name regexes

Type: array of string Default: []

CLOJURE_CLJSTYLE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_FILE_NAMES_REGEX CLOJURE_CLJSTYLE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE

CLOJURE_CLJSTYLE: Excluding Regex

Type: string

CLOJURE_CLJSTYLE: Custom regex excluding filter: files matching this regex will NOT be linted

root CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE

CLOJURE_CLJSTYLE: Including Regex

Type: string

CLOJURE_CLJSTYLE: Custom regex including filter: only files matching this regex will be linted

root CLOJURE_CLJSTYLE_POST_COMMANDS

CLOJURE_CLJSTYLE: Post-run commands

Type: array

CLOJURECLJSTYLE: Define bash commands to run after running CLOJURECLJSTYLE

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_POST_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_CLJSTYLE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_CLJSTYLE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_CLJSTYLE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_CLJSTYLE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_POST_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_CLJSTYLE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_CLJSTYLE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_CLJSTYLE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOJURE_CLJSTYLE_PRE_COMMANDS

CLOJURE_CLJSTYLE: Pre-run commands

Type: array

CLOJURECLJSTYLE: Define bash commands to run before running CLOJURECLJSTYLE

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_CLJSTYLE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOJURE_CLJSTYLE_RULES_PATH

CLOJURE_CLJSTYLE: Custom config file path

Type: string

CLOJURE_CLJSTYLE: Path where to find linter configuration file

root CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES

CLOJURE_CLJSTYLE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CLOJURE_CLJSTYLE and its pre/post commands

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES items
Type: string

root CLOJURE_CLJ_KONDO_ARGUMENTS

CLOJURE_CLJ_KONDO: Custom arguments

Type: array of string or string

CLOJURECLJKONDO: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_ARGUMENTS CLOJURE_CLJ_KONDO_ARGUMENTS items
Type: string

root CLOJURE_CLJ_KONDO_CLI_EXECUTABLE

CLOJURE_CLJ_KONDO: CLI Executable

Type: array of string Default: [["clj-kondo"]]

CLOJURECLJKONDO: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_CLI_EXECUTABLE CLOJURE_CLJ_KONDO_CLI_EXECUTABLE items
Type: string

root CLOJURE_CLJ_KONDO_CLI_LINT_MODE

CLOJURE_CLJ_KONDO: CLI lint mode

Type: enum (of string) Default: "file"

CLOJURECLJKONDO: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS

CLOJURE_CLJ_KONDO: Custom remove arguments

Type: array of string or string

CLOJURECLJKONDO: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CLOJURE_CLJ_KONDO_CONFIG_FILE

CLOJURE_CLJ_KONDO: Custom config file name

Type: string Default: ".clj-kondo/config.edn"

CLOJURECLJKONDO: User custom config file name if different from default

root CLOJURE_CLJ_KONDO_DISABLE_ERRORS

CLOJURE_CLJ_KONDO: Disable errors

Type: boolean Default: false

CLOJURECLJKONDO: If true, CLOJURECLJKONDO doesn't make MegaLinter fail even if errors are found

root CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN

CLOJURE_CLJ_KONDO: Maximum number of errors allowed

Type: number Default: 0

CLOJURECLJKONDO: If the number of errors found is less than this value, CLOJURECLJKONDO doesn't make MegaLinter fail

root CLOJURE_CLJ_KONDO_FILE_EXTENSIONS

CLOJURE_CLJ_KONDO: Matching files extensions

Type: array of string Default: [".clj", ".cljs", ".cljc", ".edn"]

CLOJURECLJKONDO: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_FILE_EXTENSIONS CLOJURE_CLJ_KONDO_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX

CLOJURE_CLJ_KONDO: Matching file name regexes

Type: array of string Default: []

CLOJURECLJKONDO: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE

CLOJURE_CLJ_KONDO: Excluding Regex

Type: string

CLOJURECLJKONDO: Custom regex excluding filter: files matching this regex will NOT be linted

root CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE

CLOJURE_CLJ_KONDO: Including Regex

Type: string

CLOJURECLJKONDO: Custom regex including filter: only files matching this regex will be linted

root CLOJURE_CLJ_KONDO_POST_COMMANDS

CLOJURE_CLJ_KONDO: Post-run commands

Type: array

CLOJURECLJKONDO: Define bash commands to run after running CLOJURECLJKONDO

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_CLJ_KONDO_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOJURE_CLJ_KONDO_PRE_COMMANDS

CLOJURE_CLJ_KONDO: Pre-run commands

Type: array

CLOJURECLJKONDO: Define bash commands to run before running CLOJURECLJKONDO

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_CLJ_KONDO_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOJURE_CLJ_KONDO_RULES_PATH

CLOJURE_CLJ_KONDO: Custom config file path

Type: string

CLOJURECLJKONDO: Path where to find linter configuration file

root CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES

CLOJURE_CLJ_KONDO: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CLOJURECLJKONDO and its pre/post commands

 No Additional Items

Each item of this array must be:

root CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES items
Type: string

root CLOJURE_FILTER_REGEX_EXCLUDE

Excluding regex filter for CLOJURE descriptor

Type: string

CLOJURE: Custom regex excluding filter: files matching this regex will NOT be linted

root CLOJURE_FILTER_REGEX_INCLUDE

Including regex filter for CLOJURE descriptor

Type: string

CLOJURE: Custom regex including filter: only files matching this regex will be linted

root CLOJURE_POST_COMMANDS

Post commands for CLOJURE descriptor

Type: array

CLOJURE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root CLOJURE_POST_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_POST_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOJURE_PRE_COMMANDS

Pre commands for CLOJURE descriptor

Type: array

CLOJURE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root CLOJURE_PRE_COMMANDS Command

Command

Type: object

Command information

root CLOJURE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOJURE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOJURE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOJURE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOJURE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CLOJURE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOJURE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOJURE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOUDFORMATION_CFN_LINT_ARGUMENTS

CLOUDFORMATION_CFN_LINT: Custom arguments

Type: array of string or string

CLOUDFORMATIONCFNLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_ARGUMENTS CLOUDFORMATION_CFN_LINT_ARGUMENTS items
Type: string

root CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE

CLOUDFORMATION_CFN_LINT: CLI Executable

Type: array of string Default: [["cfn-lint"]]

CLOUDFORMATIONCFNLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE items
Type: string

root CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE

CLOUDFORMATION_CFN_LINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CLOUDFORMATIONCFNLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS

CLOUDFORMATION_CFN_LINT: Custom remove arguments

Type: array of string or string

CLOUDFORMATIONCFNLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CLOUDFORMATION_CFN_LINT_CONFIG_FILE

CLOUDFORMATION_CFN_LINT: Custom config file name

Type: string Default: ".cfnlintrc.yml"

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

root CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS

CLOUDFORMATION_CFN_LINT: Disable errors

Type: boolean Default: false

CLOUDFORMATIONCFNLINT: If true, CLOUDFORMATIONCFNLINT doesn't make MegaLinter fail even if errors are found

root CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN

CLOUDFORMATION_CFN_LINT: Maximum number of errors allowed

Type: number Default: 0

CLOUDFORMATIONCFNLINT: If the number of errors found is less than this value, CLOUDFORMATIONCFNLINT doesn't make MegaLinter fail

root CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS

CLOUDFORMATION_CFN_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

CLOUDFORMATIONCFNLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX

CLOUDFORMATION_CFN_LINT: Matching file name regexes

Type: array of string Default: []

CLOUDFORMATIONCFNLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE

CLOUDFORMATION_CFN_LINT: Excluding Regex

Type: string

CLOUDFORMATIONCFNLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE

CLOUDFORMATION_CFN_LINT: Including Regex

Type: string

CLOUDFORMATIONCFNLINT: Custom regex including filter: only files matching this regex will be linted

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS

CLOUDFORMATION_CFN_LINT: Post-run commands

Type: array

CLOUDFORMATIONCFNLINT: Define bash commands to run after running CLOUDFORMATIONCFNLINT

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS

CLOUDFORMATION_CFN_LINT: Pre-run commands

Type: array

CLOUDFORMATIONCFNLINT: Define bash commands to run before running CLOUDFORMATIONCFNLINT

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOUDFORMATION_CFN_LINT_RULES_PATH

CLOUDFORMATION_CFN_LINT: Custom config file path

Type: string

CLOUDFORMATIONCFNLINT: Path where to find linter configuration file

root CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES

CLOUDFORMATION_CFN_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CLOUDFORMATIONCFNLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root CLOUDFORMATION_FILTER_REGEX_EXCLUDE

Excluding regex filter for CLOUDFORMATION descriptor

Type: string

CLOUDFORMATION: Custom regex excluding filter: files matching this regex will NOT be linted

root CLOUDFORMATION_FILTER_REGEX_INCLUDE

Including regex filter for CLOUDFORMATION descriptor

Type: string

CLOUDFORMATION: Custom regex including filter: only files matching this regex will be linted

root CLOUDFORMATION_POST_COMMANDS

Post commands for CLOUDFORMATION descriptor

Type: array

CLOUDFORMATION: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_POST_COMMANDS Command

Command

Type: object

Command information

root CLOUDFORMATION_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOUDFORMATION_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOUDFORMATION_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOUDFORMATION_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_POST_COMMANDS Command output_variables output_variables items
Type: string

root CLOUDFORMATION_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOUDFORMATION_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOUDFORMATION_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CLOUDFORMATION_PRE_COMMANDS

Pre commands for CLOUDFORMATION descriptor

Type: array

CLOUDFORMATION: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_PRE_COMMANDS Command

Command

Type: object

Command information

root CLOUDFORMATION_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CLOUDFORMATION_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CLOUDFORMATION_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CLOUDFORMATION_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CLOUDFORMATION_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CLOUDFORMATION_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CLOUDFORMATION_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CLOUDFORMATION_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COFFEE_COFFEELINT_ARGUMENTS

COFFEE_COFFEELINT: Custom arguments

Type: array of string or string

COFFEE_COFFEELINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_ARGUMENTS COFFEE_COFFEELINT_ARGUMENTS items
Type: string

root COFFEE_COFFEELINT_CLI_EXECUTABLE

COFFEE_COFFEELINT: CLI Executable

Type: array of string Default: [["coffeelint"]]

COFFEE_COFFEELINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_CLI_EXECUTABLE COFFEE_COFFEELINT_CLI_EXECUTABLE items
Type: string

root COFFEE_COFFEELINT_CLI_LINT_MODE

COFFEE_COFFEELINT: CLI lint mode

Type: enum (of string) Default: "file"

COFFEE_COFFEELINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS

COFFEE_COFFEELINT: Custom remove arguments

Type: array of string or string

COFFEE_COFFEELINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root COFFEE_COFFEELINT_CONFIG_FILE

COFFEE_COFFEELINT: Custom config file name

Type: string Default: ".coffee-lint.json"

COFFEE_COFFEELINT: User custom config file name if different from default

root COFFEE_COFFEELINT_DISABLE_ERRORS

COFFEE_COFFEELINT: Disable errors

Type: boolean Default: false

COFFEECOFFEELINT: If true, COFFEECOFFEELINT doesn't make MegaLinter fail even if errors are found

root COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN

COFFEE_COFFEELINT: Maximum number of errors allowed

Type: number Default: 0

COFFEECOFFEELINT: If the number of errors found is less than this value, COFFEECOFFEELINT doesn't make MegaLinter fail

root COFFEE_COFFEELINT_FILE_EXTENSIONS

COFFEE_COFFEELINT: Matching files extensions

Type: array of string Default: [".coffee"]

COFFEE_COFFEELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_FILE_EXTENSIONS COFFEE_COFFEELINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root COFFEE_COFFEELINT_FILE_NAMES_REGEX

COFFEE_COFFEELINT: Matching file name regexes

Type: array of string Default: []

COFFEE_COFFEELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_FILE_NAMES_REGEX COFFEE_COFFEELINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE

COFFEE_COFFEELINT: Excluding Regex

Type: string

COFFEE_COFFEELINT: Custom regex excluding filter: files matching this regex will NOT be linted

root COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE

COFFEE_COFFEELINT: Including Regex

Type: string

COFFEE_COFFEELINT: Custom regex including filter: only files matching this regex will be linted

root COFFEE_COFFEELINT_POST_COMMANDS

COFFEE_COFFEELINT: Post-run commands

Type: array

COFFEECOFFEELINT: Define bash commands to run after running COFFEECOFFEELINT

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_POST_COMMANDS Command

Command

Type: object

Command information

root COFFEE_COFFEELINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COFFEE_COFFEELINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COFFEE_COFFEELINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COFFEE_COFFEELINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root COFFEE_COFFEELINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COFFEE_COFFEELINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COFFEE_COFFEELINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COFFEE_COFFEELINT_PRE_COMMANDS

COFFEE_COFFEELINT: Pre-run commands

Type: array

COFFEECOFFEELINT: Define bash commands to run before running COFFEECOFFEELINT

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_PRE_COMMANDS Command

Command

Type: object

Command information

root COFFEE_COFFEELINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COFFEE_COFFEELINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COFFEE_COFFEELINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COFFEE_COFFEELINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root COFFEE_COFFEELINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COFFEE_COFFEELINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COFFEE_COFFEELINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COFFEE_COFFEELINT_RULES_PATH

COFFEE_COFFEELINT: Custom config file path

Type: string

COFFEE_COFFEELINT: Path where to find linter configuration file

root COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES

COFFEE_COFFEELINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling COFFEE_COFFEELINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES items
Type: string

root COFFEE_FILTER_REGEX_EXCLUDE

Excluding regex filter for COFFEE descriptor

Type: string

COFFEE: Custom regex excluding filter: files matching this regex will NOT be linted

root COFFEE_FILTER_REGEX_INCLUDE

Including regex filter for COFFEE descriptor

Type: string

COFFEE: Custom regex including filter: only files matching this regex will be linted

root COFFEE_POST_COMMANDS

Post commands for COFFEE descriptor

Type: array

COFFEE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root COFFEE_POST_COMMANDS Command

Command

Type: object

Command information

root COFFEE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COFFEE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COFFEE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COFFEE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COFFEE_POST_COMMANDS Command output_variables output_variables items
Type: string

root COFFEE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COFFEE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COFFEE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COFFEE_PRE_COMMANDS

Pre commands for COFFEE descriptor

Type: array

COFFEE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root COFFEE_PRE_COMMANDS Command

Command

Type: object

Command information

root COFFEE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COFFEE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COFFEE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COFFEE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COFFEE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root COFFEE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COFFEE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COFFEE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CONFIG_PROPERTIES_TO_APPEND

List of configuration properties to append their values

Type: array of string

List of configuration properties to append their values (instead of replacing them) in case of using EXTENDS.

 No Additional Items

Each item of this array must be:

root CONFIG_PROPERTIES_TO_APPEND CONFIG_PROPERTIES_TO_APPEND items
Type: string

Example:

[
    "ENABLE_LINTERS"
]

root CONFIG_REPORTER

Activate local configuration reporter

Type: boolean Default: true

Generates a folder IDE-config located in report folder, containing default MegaLinter configuration files used during the linting, and updated VSCode extensions.js config file

root CONFIG_REPORTER_SUB_FOLDER

Output folder for IDE configuration files within report folder

Type: string Default: "IDE-config"

root CONSOLE_REPORTER

Activate console reporter

Type: boolean Default: true

root CONSOLE_REPORTER_SECTIONS

Activate console logs sections

Type: boolean Default: true

Define to false if you do not want logs to be organized in sections

root COPYPASTE_FILTER_REGEX_EXCLUDE

Excluding regex filter for COPYPASTE descriptor

Type: string

COPYPASTE: Custom regex excluding filter: files matching this regex will NOT be linted

root COPYPASTE_FILTER_REGEX_INCLUDE

Including regex filter for COPYPASTE descriptor

Type: string

COPYPASTE: Custom regex including filter: only files matching this regex will be linted

root COPYPASTE_JSCPD_ARGUMENTS

COPYPASTE_JSCPD: Custom arguments

Type: array of string or string

COPYPASTE_JSCPD: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_ARGUMENTS COPYPASTE_JSCPD_ARGUMENTS items
Type: string

root COPYPASTE_JSCPD_CLI_EXECUTABLE

COPYPASTE_JSCPD: CLI Executable

Type: array of string Default: [["jscpd"]]

COPYPASTE_JSCPD: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_CLI_EXECUTABLE COPYPASTE_JSCPD_CLI_EXECUTABLE items
Type: string

root COPYPASTE_JSCPD_CLI_LINT_MODE

COPYPASTE_JSCPD: CLI lint mode

Type: enum (of string) Default: "project"

COPYPASTE_JSCPD: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS

COPYPASTE_JSCPD: Custom remove arguments

Type: array of string or string

COPYPASTE_JSCPD: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS items
Type: string

root COPYPASTE_JSCPD_CONFIG_FILE

COPYPASTE_JSCPD: Custom config file name

Type: string Default: ".jscpd.json"

COPYPASTE_JSCPD: User custom config file name if different from default

root COPYPASTE_JSCPD_DISABLE_ERRORS

COPYPASTE_JSCPD: Disable errors

Type: boolean Default: false

COPYPASTEJSCPD: If true, COPYPASTEJSCPD doesn't make MegaLinter fail even if errors are found

root COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN

COPYPASTE_JSCPD: Maximum number of errors allowed

Type: number Default: 0

COPYPASTEJSCPD: If the number of errors found is less than this value, COPYPASTEJSCPD doesn't make MegaLinter fail

root COPYPASTE_JSCPD_POST_COMMANDS

COPYPASTE_JSCPD: Post-run commands

Type: array

COPYPASTEJSCPD: Define bash commands to run after running COPYPASTEJSCPD

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_POST_COMMANDS Command

Command

Type: object

Command information

root COPYPASTE_JSCPD_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COPYPASTE_JSCPD_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COPYPASTE_JSCPD_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COPYPASTE_JSCPD_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_POST_COMMANDS Command output_variables output_variables items
Type: string

root COPYPASTE_JSCPD_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COPYPASTE_JSCPD_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COPYPASTE_JSCPD_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COPYPASTE_JSCPD_PRE_COMMANDS

COPYPASTE_JSCPD: Pre-run commands

Type: array

COPYPASTEJSCPD: Define bash commands to run before running COPYPASTEJSCPD

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_PRE_COMMANDS Command

Command

Type: object

Command information

root COPYPASTE_JSCPD_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COPYPASTE_JSCPD_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COPYPASTE_JSCPD_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COPYPASTE_JSCPD_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_PRE_COMMANDS Command output_variables output_variables items
Type: string

root COPYPASTE_JSCPD_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COPYPASTE_JSCPD_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COPYPASTE_JSCPD_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COPYPASTE_JSCPD_RULES_PATH

COPYPASTE_JSCPD: Custom config file path

Type: string

COPYPASTE_JSCPD: Path where to find linter configuration file

root COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES

COPYPASTE_JSCPD: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling COPYPASTE_JSCPD and its pre/post commands

 No Additional Items

Each item of this array must be:

root COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES items
Type: string

root COPYPASTE_POST_COMMANDS

Post commands for COPYPASTE descriptor

Type: array

COPYPASTE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root COPYPASTE_POST_COMMANDS Command

Command

Type: object

Command information

root COPYPASTE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COPYPASTE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COPYPASTE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COPYPASTE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COPYPASTE_POST_COMMANDS Command output_variables output_variables items
Type: string

root COPYPASTE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COPYPASTE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COPYPASTE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root COPYPASTE_PRE_COMMANDS

Pre commands for COPYPASTE descriptor

Type: array

COPYPASTE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root COPYPASTE_PRE_COMMANDS Command

Command

Type: object

Command information

root COPYPASTE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root COPYPASTE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root COPYPASTE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root COPYPASTE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root COPYPASTE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root COPYPASTE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root COPYPASTE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root COPYPASTE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CLANG_FORMAT_ARGUMENTS

CPP_CLANG_FORMAT: Custom arguments

Type: array of string or string

CPPCLANGFORMAT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_ARGUMENTS CPP_CLANG_FORMAT_ARGUMENTS items
Type: string

root CPP_CLANG_FORMAT_CLI_EXECUTABLE

CPP_CLANG_FORMAT: CLI Executable

Type: array of string Default: [["clang-format"]]

CPPCLANGFORMAT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_CLI_EXECUTABLE CPP_CLANG_FORMAT_CLI_EXECUTABLE items
Type: string

root CPP_CLANG_FORMAT_CLI_LINT_MODE

CPP_CLANG_FORMAT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CPPCLANGFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS

CPP_CLANG_FORMAT: Custom remove arguments

Type: array of string or string

CPPCLANGFORMAT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CPP_CLANG_FORMAT_CONFIG_FILE

CPP_CLANG_FORMAT: Custom config file name

Type: string Default: ".clang-format"

CPPCLANGFORMAT: User custom config file name if different from default

root CPP_CLANG_FORMAT_DISABLE_ERRORS

CPP_CLANG_FORMAT: Disable errors

Type: boolean Default: false

CPPCLANGFORMAT: If true, CPPCLANGFORMAT doesn't make MegaLinter fail even if errors are found

root CPP_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN

CPP_CLANG_FORMAT: Maximum number of errors allowed

Type: number Default: 0

CPPCLANGFORMAT: If the number of errors found is less than this value, CPPCLANGFORMAT doesn't make MegaLinter fail

root CPP_CLANG_FORMAT_FILE_EXTENSIONS

CPP_CLANG_FORMAT: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

CPPCLANGFORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_FILE_EXTENSIONS CPP_CLANG_FORMAT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CPP_CLANG_FORMAT_FILE_NAMES_REGEX

CPP_CLANG_FORMAT: Matching file name regexes

Type: array of string Default: []

CPPCLANGFORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_FILE_NAMES_REGEX CPP_CLANG_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CPP_CLANG_FORMAT_FILTER_REGEX_EXCLUDE

CPP_CLANG_FORMAT: Excluding Regex

Type: string

CPPCLANGFORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

root CPP_CLANG_FORMAT_FILTER_REGEX_INCLUDE

CPP_CLANG_FORMAT: Including Regex

Type: string

CPPCLANGFORMAT: Custom regex including filter: only files matching this regex will be linted

root CPP_CLANG_FORMAT_POST_COMMANDS

CPP_CLANG_FORMAT: Post-run commands

Type: array

CPPCLANGFORMAT: Define bash commands to run after running CPPCLANGFORMAT

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_POST_COMMANDS Command

Command

Type: object

Command information

root CPP_CLANG_FORMAT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CLANG_FORMAT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CLANG_FORMAT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CLANG_FORMAT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CLANG_FORMAT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CLANG_FORMAT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CLANG_FORMAT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CLANG_FORMAT_PRE_COMMANDS

CPP_CLANG_FORMAT: Pre-run commands

Type: array

CPPCLANGFORMAT: Define bash commands to run before running CPPCLANGFORMAT

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_PRE_COMMANDS Command

Command

Type: object

Command information

root CPP_CLANG_FORMAT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CLANG_FORMAT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CLANG_FORMAT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CLANG_FORMAT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CLANG_FORMAT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CLANG_FORMAT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CLANG_FORMAT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CLANG_FORMAT_RULES_PATH

CPP_CLANG_FORMAT: Custom config file path

Type: string

CPPCLANGFORMAT: Path where to find linter configuration file

root CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES

CPP_CLANG_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CPPCLANGFORMAT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES items
Type: string

root CPP_CPPCHECK_ARGUMENTS

CPP_CPPCHECK: Custom arguments

Type: array of string or string

CPP_CPPCHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_ARGUMENTS CPP_CPPCHECK_ARGUMENTS items
Type: string

root CPP_CPPCHECK_CLI_EXECUTABLE

CPP_CPPCHECK: CLI Executable

Type: array of string Default: [["cppcheck"]]

CPP_CPPCHECK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_CLI_EXECUTABLE CPP_CPPCHECK_CLI_EXECUTABLE items
Type: string

root CPP_CPPCHECK_CLI_LINT_MODE

CPP_CPPCHECK: CLI lint mode

Type: enum (of string) Default: "file"

CPP_CPPCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root CPP_CPPCHECK_COMMAND_REMOVE_ARGUMENTS

CPP_CPPCHECK: Custom remove arguments

Type: array of string or string

CPP_CPPCHECK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_COMMAND_REMOVE_ARGUMENTS CPP_CPPCHECK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CPP_CPPCHECK_DISABLE_ERRORS

CPP_CPPCHECK: Disable errors

Type: boolean Default: false

CPPCPPCHECK: If true, CPPCPPCHECK doesn't make MegaLinter fail even if errors are found

root CPP_CPPCHECK_DISABLE_ERRORS_IF_LESS_THAN

CPP_CPPCHECK: Maximum number of errors allowed

Type: number Default: 0

CPPCPPCHECK: If the number of errors found is less than this value, CPPCPPCHECK doesn't make MegaLinter fail

root CPP_CPPCHECK_FILE_EXTENSIONS

CPP_CPPCHECK: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

CPP_CPPCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_FILE_EXTENSIONS CPP_CPPCHECK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CPP_CPPCHECK_FILE_NAMES_REGEX

CPP_CPPCHECK: Matching file name regexes

Type: array of string Default: []

CPP_CPPCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_FILE_NAMES_REGEX CPP_CPPCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CPP_CPPCHECK_FILTER_REGEX_EXCLUDE

CPP_CPPCHECK: Excluding Regex

Type: string

CPP_CPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

root CPP_CPPCHECK_FILTER_REGEX_INCLUDE

CPP_CPPCHECK: Including Regex

Type: string

CPP_CPPCHECK: Custom regex including filter: only files matching this regex will be linted

root CPP_CPPCHECK_POST_COMMANDS

CPP_CPPCHECK: Post-run commands

Type: array

CPPCPPCHECK: Define bash commands to run after running CPPCPPCHECK

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_POST_COMMANDS Command

Command

Type: object

Command information

root CPP_CPPCHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CPPCHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CPPCHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CPPCHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CPPCHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CPPCHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CPPCHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CPPCHECK_PRE_COMMANDS

CPP_CPPCHECK: Pre-run commands

Type: array

CPPCPPCHECK: Define bash commands to run before running CPPCPPCHECK

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root CPP_CPPCHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CPPCHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CPPCHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CPPCHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CPPCHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CPPCHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CPPCHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CPPCHECK_UNSECURED_ENV_VARIABLES

CPP_CPPCHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CPP_CPPCHECK and its pre/post commands

 No Additional Items

Each item of this array must be:

root CPP_CPPCHECK_UNSECURED_ENV_VARIABLES CPP_CPPCHECK_UNSECURED_ENV_VARIABLES items
Type: string

root CPP_CPPLINT_ARGUMENTS

CPP_CPPLINT: Custom arguments

Type: array of string or string

CPP_CPPLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_ARGUMENTS CPP_CPPLINT_ARGUMENTS items
Type: string

root CPP_CPPLINT_CLI_EXECUTABLE

CPP_CPPLINT: CLI Executable

Type: array of string Default: [["cpplint"]]

CPP_CPPLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_CLI_EXECUTABLE CPP_CPPLINT_CLI_EXECUTABLE items
Type: string

root CPP_CPPLINT_CLI_LINT_MODE

CPP_CPPLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CPP_CPPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS

CPP_CPPLINT: Custom remove arguments

Type: array of string or string

CPP_CPPLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CPP_CPPLINT_DISABLE_ERRORS

CPP_CPPLINT: Disable errors

Type: boolean Default: false

CPPCPPLINT: If true, CPPCPPLINT doesn't make MegaLinter fail even if errors are found

root CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN

CPP_CPPLINT: Maximum number of errors allowed

Type: number Default: 0

CPPCPPLINT: If the number of errors found is less than this value, CPPCPPLINT doesn't make MegaLinter fail

root CPP_CPPLINT_FILE_EXTENSIONS

CPP_CPPLINT: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

CPP_CPPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_FILE_EXTENSIONS CPP_CPPLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CPP_CPPLINT_FILE_NAMES_REGEX

CPP_CPPLINT: Matching file name regexes

Type: array of string Default: []

CPP_CPPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_FILE_NAMES_REGEX CPP_CPPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CPP_CPPLINT_FILTER_REGEX_EXCLUDE

CPP_CPPLINT: Excluding Regex

Type: string

CPP_CPPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root CPP_CPPLINT_FILTER_REGEX_INCLUDE

CPP_CPPLINT: Including Regex

Type: string

CPP_CPPLINT: Custom regex including filter: only files matching this regex will be linted

root CPP_CPPLINT_POST_COMMANDS

CPP_CPPLINT: Post-run commands

Type: array

CPPCPPLINT: Define bash commands to run after running CPPCPPLINT

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_POST_COMMANDS Command

Command

Type: object

Command information

root CPP_CPPLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CPPLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CPPLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CPPLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CPPLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CPPLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CPPLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CPPLINT_PRE_COMMANDS

CPP_CPPLINT: Pre-run commands

Type: array

CPPCPPLINT: Define bash commands to run before running CPPCPPLINT

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root CPP_CPPLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_CPPLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_CPPLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_CPPLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CPP_CPPLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_CPPLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_CPPLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_CPPLINT_UNSECURED_ENV_VARIABLES

CPP_CPPLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CPP_CPPLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CPP_CPPLINT_UNSECURED_ENV_VARIABLES CPP_CPPLINT_UNSECURED_ENV_VARIABLES items
Type: string

root CPP_FILTER_REGEX_EXCLUDE

Excluding regex filter for CPP descriptor

Type: string

CPP: Custom regex excluding filter: files matching this regex will NOT be linted

root CPP_FILTER_REGEX_INCLUDE

Including regex filter for CPP descriptor

Type: string

CPP: Custom regex including filter: only files matching this regex will be linted

root CPP_POST_COMMANDS

Post commands for CPP descriptor

Type: array

CPP: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root CPP_POST_COMMANDS Command

Command

Type: object

Command information

root CPP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_POST_COMMANDS Command output_variables output_variables items
Type: string

root CPP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CPP_PRE_COMMANDS

Pre commands for CPP descriptor

Type: array

CPP: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root CPP_PRE_COMMANDS Command

Command

Type: object

Command information

root CPP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CPP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CPP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CPP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CPP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CPP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CPP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CPP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_CSHARPIER_ARGUMENTS

CSHARP_CSHARPIER: Custom arguments

Type: array of string or string

CSHARP_CSHARPIER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_ARGUMENTS CSHARP_CSHARPIER_ARGUMENTS items
Type: string

root CSHARP_CSHARPIER_CLI_EXECUTABLE

CSHARP_CSHARPIER: CLI Executable

Type: array of string Default: [["csharpier"]]

CSHARP_CSHARPIER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_CLI_EXECUTABLE CSHARP_CSHARPIER_CLI_EXECUTABLE items
Type: string

root CSHARP_CSHARPIER_CLI_LINT_MODE

CSHARP_CSHARPIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CSHARP_CSHARPIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS

CSHARP_CSHARPIER: Custom remove arguments

Type: array of string or string

CSHARP_CSHARPIER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CSHARP_CSHARPIER_CONFIG_FILE

CSHARP_CSHARPIER: Custom config file name

Type: string Default: ".csharpierrc"

CSHARP_CSHARPIER: User custom config file name if different from default

root CSHARP_CSHARPIER_DISABLE_ERRORS

CSHARP_CSHARPIER: Disable errors

Type: boolean Default: false

CSHARPCSHARPIER: If true, CSHARPCSHARPIER doesn't make MegaLinter fail even if errors are found

root CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN

CSHARP_CSHARPIER: Maximum number of errors allowed

Type: number Default: 0

CSHARPCSHARPIER: If the number of errors found is less than this value, CSHARPCSHARPIER doesn't make MegaLinter fail

root CSHARP_CSHARPIER_FILE_EXTENSIONS

CSHARP_CSHARPIER: Matching files extensions

Type: array of string Default: [".config", ".cs", ".csproj", ".props", ".targets"]

CSHARP_CSHARPIER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_FILE_EXTENSIONS CSHARP_CSHARPIER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CSHARP_CSHARPIER_FILE_NAMES_REGEX

CSHARP_CSHARPIER: Matching file name regexes

Type: array of string Default: []

CSHARP_CSHARPIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_FILE_NAMES_REGEX CSHARP_CSHARPIER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE

CSHARP_CSHARPIER: Excluding Regex

Type: string

CSHARP_CSHARPIER: Custom regex excluding filter: files matching this regex will NOT be linted

root CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE

CSHARP_CSHARPIER: Including Regex

Type: string

CSHARP_CSHARPIER: Custom regex including filter: only files matching this regex will be linted

root CSHARP_CSHARPIER_POST_COMMANDS

CSHARP_CSHARPIER: Post-run commands

Type: array

CSHARPCSHARPIER: Define bash commands to run after running CSHARPCSHARPIER

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_POST_COMMANDS Command

Command

Type: object

Command information

root CSHARP_CSHARPIER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_CSHARPIER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_CSHARPIER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_CSHARPIER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_CSHARPIER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_CSHARPIER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_CSHARPIER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_CSHARPIER_PRE_COMMANDS

CSHARP_CSHARPIER: Pre-run commands

Type: array

CSHARPCSHARPIER: Define bash commands to run before running CSHARPCSHARPIER

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_PRE_COMMANDS Command

Command

Type: object

Command information

root CSHARP_CSHARPIER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_CSHARPIER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_CSHARPIER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_CSHARPIER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_CSHARPIER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_CSHARPIER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_CSHARPIER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_CSHARPIER_RULES_PATH

CSHARP_CSHARPIER: Custom config file path

Type: string

CSHARP_CSHARPIER: Path where to find linter configuration file

root CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES

CSHARP_CSHARPIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CSHARP_CSHARPIER and its pre/post commands

 No Additional Items

Each item of this array must be:

root CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES items
Type: string

root CSHARP_DOTNET_FORMAT_ARGUMENTS

CSHARP_DOTNET_FORMAT: Custom arguments

Type: array of string or string

CSHARPDOTNETFORMAT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_ARGUMENTS CSHARP_DOTNET_FORMAT_ARGUMENTS items
Type: string

root CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE

CSHARP_DOTNET_FORMAT: CLI Executable

Type: array of string Default: [["dotnet"]]

CSHARPDOTNETFORMAT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE items
Type: string

root CSHARP_DOTNET_FORMAT_CLI_LINT_MODE

CSHARP_DOTNET_FORMAT: CLI lint mode

Type: enum (of string) Default: "project"

CSHARPDOTNETFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS

CSHARP_DOTNET_FORMAT: Custom remove arguments

Type: array of string or string

CSHARPDOTNETFORMAT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CSHARP_DOTNET_FORMAT_DISABLE_ERRORS

CSHARP_DOTNET_FORMAT: Disable errors

Type: boolean Default: false

CSHARPDOTNETFORMAT: If true, CSHARPDOTNETFORMAT doesn't make MegaLinter fail even if errors are found

root CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN

CSHARP_DOTNET_FORMAT: Maximum number of errors allowed

Type: number Default: 0

CSHARPDOTNETFORMAT: If the number of errors found is less than this value, CSHARPDOTNETFORMAT doesn't make MegaLinter fail

root CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS

CSHARP_DOTNET_FORMAT: Matching files extensions

Type: array of string Default: [".cs"]

CSHARPDOTNETFORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX

CSHARP_DOTNET_FORMAT: Matching file name regexes

Type: array of string Default: []

CSHARPDOTNETFORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CSHARP_DOTNET_FORMAT_POST_COMMANDS

CSHARP_DOTNET_FORMAT: Post-run commands

Type: array

CSHARPDOTNETFORMAT: Define bash commands to run after running CSHARPDOTNETFORMAT

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command

Command

Type: object

Command information

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_DOTNET_FORMAT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS

CSHARP_DOTNET_FORMAT: Pre-run commands

Type: array

CSHARPDOTNETFORMAT: Define bash commands to run before running CSHARPDOTNETFORMAT

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command

Command

Type: object

Command information

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES

CSHARP_DOTNET_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CSHARPDOTNETFORMAT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES items
Type: string

root CSHARP_FILTER_REGEX_EXCLUDE

Excluding regex filter for CSHARP descriptor

Type: string

CSHARP: Custom regex excluding filter: files matching this regex will NOT be linted

root CSHARP_FILTER_REGEX_INCLUDE

Including regex filter for CSHARP descriptor

Type: string

CSHARP: Custom regex including filter: only files matching this regex will be linted

root CSHARP_POST_COMMANDS

Post commands for CSHARP descriptor

Type: array

CSHARP: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root CSHARP_POST_COMMANDS Command

Command

Type: object

Command information

root CSHARP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_PRE_COMMANDS

Pre commands for CSHARP descriptor

Type: array

CSHARP: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root CSHARP_PRE_COMMANDS Command

Command

Type: object

Command information

root CSHARP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_ROSLYNATOR_ARGUMENTS

CSHARP_ROSLYNATOR: Custom arguments

Type: array of string or string

CSHARP_ROSLYNATOR: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_ARGUMENTS CSHARP_ROSLYNATOR_ARGUMENTS items
Type: string

root CSHARP_ROSLYNATOR_CLI_EXECUTABLE

CSHARP_ROSLYNATOR: CLI Executable

Type: array of string Default: [["roslynator"]]

CSHARP_ROSLYNATOR: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_CLI_EXECUTABLE CSHARP_ROSLYNATOR_CLI_EXECUTABLE items
Type: string

root CSHARP_ROSLYNATOR_CLI_LINT_MODE

CSHARP_ROSLYNATOR: CLI lint mode

Type: enum (of string) Default: "file"

CSHARP_ROSLYNATOR: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS

CSHARP_ROSLYNATOR: Custom remove arguments

Type: array of string or string

CSHARP_ROSLYNATOR: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CSHARP_ROSLYNATOR_DISABLE_ERRORS

CSHARP_ROSLYNATOR: Disable errors

Type: boolean Default: false

CSHARPROSLYNATOR: If true, CSHARPROSLYNATOR doesn't make MegaLinter fail even if errors are found

root CSHARP_ROSLYNATOR_DISABLE_ERRORS_IF_LESS_THAN

CSHARP_ROSLYNATOR: Maximum number of errors allowed

Type: number Default: 0

CSHARPROSLYNATOR: If the number of errors found is less than this value, CSHARPROSLYNATOR doesn't make MegaLinter fail

root CSHARP_ROSLYNATOR_FILE_EXTENSIONS

CSHARP_ROSLYNATOR: Matching files extensions

Type: array of string Default: [".csproj"]

CSHARP_ROSLYNATOR: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_FILE_EXTENSIONS CSHARP_ROSLYNATOR_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CSHARP_ROSLYNATOR_FILE_NAMES_REGEX

CSHARP_ROSLYNATOR: Matching file name regexes

Type: array of string Default: []

CSHARP_ROSLYNATOR: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_FILE_NAMES_REGEX CSHARP_ROSLYNATOR_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CSHARP_ROSLYNATOR_FILTER_REGEX_EXCLUDE

CSHARP_ROSLYNATOR: Excluding Regex

Type: string

CSHARP_ROSLYNATOR: Custom regex excluding filter: files matching this regex will NOT be linted

root CSHARP_ROSLYNATOR_FILTER_REGEX_INCLUDE

CSHARP_ROSLYNATOR: Including Regex

Type: string

CSHARP_ROSLYNATOR: Custom regex including filter: only files matching this regex will be linted

root CSHARP_ROSLYNATOR_POST_COMMANDS

CSHARP_ROSLYNATOR: Post-run commands

Type: array

CSHARPROSLYNATOR: Define bash commands to run after running CSHARPROSLYNATOR

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_POST_COMMANDS Command

Command

Type: object

Command information

root CSHARP_ROSLYNATOR_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_ROSLYNATOR_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_ROSLYNATOR_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_ROSLYNATOR_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_ROSLYNATOR_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_ROSLYNATOR_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_ROSLYNATOR_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_ROSLYNATOR_PRE_COMMANDS

CSHARP_ROSLYNATOR: Pre-run commands

Type: array

CSHARPROSLYNATOR: Define bash commands to run before running CSHARPROSLYNATOR

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command

Command

Type: object

Command information

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSHARP_ROSLYNATOR_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES

CSHARP_ROSLYNATOR: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CSHARP_ROSLYNATOR and its pre/post commands

 No Additional Items

Each item of this array must be:

root CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES items
Type: string

root CSS_FILTER_REGEX_EXCLUDE

Excluding regex filter for CSS descriptor

Type: string

CSS: Custom regex excluding filter: files matching this regex will NOT be linted

root CSS_FILTER_REGEX_INCLUDE

Including regex filter for CSS descriptor

Type: string

CSS: Custom regex including filter: only files matching this regex will be linted

root CSS_POST_COMMANDS

Post commands for CSS descriptor

Type: array

CSS: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root CSS_POST_COMMANDS Command

Command

Type: object

Command information

root CSS_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSS_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_PRE_COMMANDS

Pre commands for CSS descriptor

Type: array

CSS: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root CSS_PRE_COMMANDS Command

Command

Type: object

Command information

root CSS_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSS_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_SCSS_LINT_ARGUMENTS

(deprecated) CSS_SCSS_LINT: Custom arguments

Type: array of string or string

CSSSCSSLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_ARGUMENTS CSS_SCSS_LINT_ARGUMENTS items
Type: string

root CSS_SCSS_LINT_CLI_EXECUTABLE

(deprecated) CSS_SCSS_LINT: CLI Executable

Type: array of string Default: [["scss-lint"]]
No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_CLI_EXECUTABLE CSS_SCSS_LINT_CLI_EXECUTABLE items
Type: string

root CSS_SCSS_LINT_CLI_LINT_MODE

(deprecated) CSS_SCSS_LINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

root CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS

(deprecated) CSS_SCSS_LINT: Custom remove arguments

Type: array of string or string

CSSSCSSLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CSS_SCSS_LINT_CONFIG_FILE

(deprecated) CSS_SCSS_LINT: Custom config file name

Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

root CSS_SCSS_LINT_DISABLE_ERRORS

(deprecated) CSS_SCSS_LINT: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN

(deprecated) CSS_SCSS_LINT: Maximum number of errors allowed

Type: number Default: 0

root CSS_SCSS_LINT_FILE_EXTENSIONS

(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_FILE_EXTENSIONS CSS_SCSS_LINT_FILE_EXTENSIONS items
Type: string

root CSS_SCSS_LINT_FILE_NAME

CSS_SCSS_LINT: Custom config file name

Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

root CSS_SCSS_LINT_FILE_NAMES_REGEX

(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_FILE_NAMES_REGEX CSS_SCSS_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE

(deprecated) CSS_SCSS_LINT: Excluding Regex

Type: string

root CSS_SCSS_LINT_FILTER_REGEX_INCLUDE

(deprecated) CSS_SCSS_LINT: Including Regex

Type: string

root CSS_SCSS_LINT_POST_COMMANDS

(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root CSS_SCSS_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_SCSS_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_SCSS_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_SCSS_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSS_SCSS_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_SCSS_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_SCSS_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_SCSS_LINT_PRE_COMMANDS

(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root CSS_SCSS_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_SCSS_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_SCSS_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_SCSS_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSS_SCSS_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_SCSS_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_SCSS_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_SCSS_LINT_RULES_PATH

(deprecated) CSS_SCSS_LINT: Custom config file path

Type: string

CSSSCSSLINT: Path where to find linter configuration file

root CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES

(deprecated) CSS_SCSS_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CSSSCSSLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root CSS_STYLELINT_ARGUMENTS

CSS_STYLELINT: Custom arguments

Type: array of string or string

CSS_STYLELINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_ARGUMENTS CSS_STYLELINT_ARGUMENTS items
Type: string

root CSS_STYLELINT_CLI_EXECUTABLE

CSS_STYLELINT: CLI Executable

Type: array of string Default: [["stylelint"]]

CSS_STYLELINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_CLI_EXECUTABLE CSS_STYLELINT_CLI_EXECUTABLE items
Type: string

root CSS_STYLELINT_CLI_LINT_MODE

CSS_STYLELINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CSS_STYLELINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS

CSS_STYLELINT: Custom remove arguments

Type: array of string or string

CSS_STYLELINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root CSS_STYLELINT_CONFIG_FILE

CSS_STYLELINT: Custom config file name

Type: string Default: ".stylelintrc.json"

CSS_STYLELINT: User custom config file name if different from default

root CSS_STYLELINT_DISABLE_ERRORS

CSS_STYLELINT: Disable errors

Type: boolean Default: false

CSSSTYLELINT: If true, CSSSTYLELINT doesn't make MegaLinter fail even if errors are found

root CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN

CSS_STYLELINT: Maximum number of errors allowed

Type: number Default: 0

CSSSTYLELINT: If the number of errors found is less than this value, CSSSTYLELINT doesn't make MegaLinter fail

root CSS_STYLELINT_FILE_EXTENSIONS

CSS_STYLELINT: Matching files extensions

Type: array of string Default: [".css", ".scss", ".saas"]

CSS_STYLELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_FILE_EXTENSIONS CSS_STYLELINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root CSS_STYLELINT_FILE_NAMES_REGEX

CSS_STYLELINT: Matching file name regexes

Type: array of string Default: []

CSS_STYLELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_FILE_NAMES_REGEX CSS_STYLELINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root CSS_STYLELINT_FILTER_REGEX_EXCLUDE

CSS_STYLELINT: Excluding Regex

Type: string

CSS_STYLELINT: Custom regex excluding filter: files matching this regex will NOT be linted

root CSS_STYLELINT_FILTER_REGEX_INCLUDE

CSS_STYLELINT: Including Regex

Type: string

CSS_STYLELINT: Custom regex including filter: only files matching this regex will be linted

root CSS_STYLELINT_POST_COMMANDS

CSS_STYLELINT: Post-run commands

Type: array

CSSSTYLELINT: Define bash commands to run after running CSSSTYLELINT

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_POST_COMMANDS Command

Command

Type: object

Command information

root CSS_STYLELINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_STYLELINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_STYLELINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_STYLELINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root CSS_STYLELINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_STYLELINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_STYLELINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_STYLELINT_PRE_COMMANDS

CSS_STYLELINT: Pre-run commands

Type: array

CSSSTYLELINT: Define bash commands to run before running CSSSTYLELINT

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_PRE_COMMANDS Command

Command

Type: object

Command information

root CSS_STYLELINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root CSS_STYLELINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root CSS_STYLELINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root CSS_STYLELINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root CSS_STYLELINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root CSS_STYLELINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root CSS_STYLELINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root CSS_STYLELINT_RULES_PATH

CSS_STYLELINT: Custom config file path

Type: string

CSS_STYLELINT: Path where to find linter configuration file

root CSS_STYLELINT_UNSECURED_ENV_VARIABLES

CSS_STYLELINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CSS_STYLELINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root CSS_STYLELINT_UNSECURED_ENV_VARIABLES CSS_STYLELINT_UNSECURED_ENV_VARIABLES items
Type: string

root C_CLANG_FORMAT_ARGUMENTS

C_CLANG_FORMAT: Custom arguments

Type: array of string or string

CCLANGFORMAT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_ARGUMENTS C_CLANG_FORMAT_ARGUMENTS items
Type: string

root C_CLANG_FORMAT_CLI_EXECUTABLE

C_CLANG_FORMAT: CLI Executable

Type: array of string Default: [["clang-format"]]

CCLANGFORMAT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_CLI_EXECUTABLE C_CLANG_FORMAT_CLI_EXECUTABLE items
Type: string

root C_CLANG_FORMAT_CLI_LINT_MODE

C_CLANG_FORMAT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

CCLANGFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root C_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS

C_CLANG_FORMAT: Custom remove arguments

Type: array of string or string

CCLANGFORMAT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS C_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root C_CLANG_FORMAT_CONFIG_FILE

C_CLANG_FORMAT: Custom config file name

Type: string Default: ".clang-format"

CCLANGFORMAT: User custom config file name if different from default

root C_CLANG_FORMAT_DISABLE_ERRORS

C_CLANG_FORMAT: Disable errors

Type: boolean Default: false

CCLANGFORMAT: If true, CCLANGFORMAT doesn't make MegaLinter fail even if errors are found

root C_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN

C_CLANG_FORMAT: Maximum number of errors allowed

Type: number Default: 0

CCLANGFORMAT: If the number of errors found is less than this value, CCLANGFORMAT doesn't make MegaLinter fail

root C_CLANG_FORMAT_FILE_EXTENSIONS

C_CLANG_FORMAT: Matching files extensions

Type: array of string Default: [".c", ".h"]

CCLANGFORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_FILE_EXTENSIONS C_CLANG_FORMAT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root C_CLANG_FORMAT_FILE_NAMES_REGEX

C_CLANG_FORMAT: Matching file name regexes

Type: array of string Default: []

CCLANGFORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_FILE_NAMES_REGEX C_CLANG_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root C_CLANG_FORMAT_FILTER_REGEX_EXCLUDE

C_CLANG_FORMAT: Excluding Regex

Type: string

CCLANGFORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

root C_CLANG_FORMAT_FILTER_REGEX_INCLUDE

C_CLANG_FORMAT: Including Regex

Type: string

CCLANGFORMAT: Custom regex including filter: only files matching this regex will be linted

root C_CLANG_FORMAT_POST_COMMANDS

C_CLANG_FORMAT: Post-run commands

Type: array

CCLANGFORMAT: Define bash commands to run after running CCLANGFORMAT

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_POST_COMMANDS Command

Command

Type: object

Command information

root C_CLANG_FORMAT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CLANG_FORMAT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CLANG_FORMAT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CLANG_FORMAT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_POST_COMMANDS Command output_variables output_variables items
Type: string

root C_CLANG_FORMAT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CLANG_FORMAT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CLANG_FORMAT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CLANG_FORMAT_PRE_COMMANDS

C_CLANG_FORMAT: Pre-run commands

Type: array

CCLANGFORMAT: Define bash commands to run before running CCLANGFORMAT

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_PRE_COMMANDS Command

Command

Type: object

Command information

root C_CLANG_FORMAT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CLANG_FORMAT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CLANG_FORMAT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CLANG_FORMAT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root C_CLANG_FORMAT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CLANG_FORMAT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CLANG_FORMAT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CLANG_FORMAT_RULES_PATH

C_CLANG_FORMAT: Custom config file path

Type: string

CCLANGFORMAT: Path where to find linter configuration file

root C_CLANG_FORMAT_UNSECURED_ENV_VARIABLES

C_CLANG_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling CCLANGFORMAT and its pre/post commands

 No Additional Items

Each item of this array must be:

root C_CLANG_FORMAT_UNSECURED_ENV_VARIABLES C_CLANG_FORMAT_UNSECURED_ENV_VARIABLES items
Type: string

root C_CPPCHECK_ARGUMENTS

C_CPPCHECK: Custom arguments

Type: array of string or string

C_CPPCHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_ARGUMENTS C_CPPCHECK_ARGUMENTS items
Type: string

root C_CPPCHECK_CLI_EXECUTABLE

C_CPPCHECK: CLI Executable

Type: array of string Default: [["cppcheck"]]

C_CPPCHECK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_CLI_EXECUTABLE C_CPPCHECK_CLI_EXECUTABLE items
Type: string

root C_CPPCHECK_CLI_LINT_MODE

C_CPPCHECK: CLI lint mode

Type: enum (of string) Default: "file"

C_CPPCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root C_CPPCHECK_COMMAND_REMOVE_ARGUMENTS

C_CPPCHECK: Custom remove arguments

Type: array of string or string

C_CPPCHECK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_COMMAND_REMOVE_ARGUMENTS C_CPPCHECK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root C_CPPCHECK_DISABLE_ERRORS

C_CPPCHECK: Disable errors

Type: boolean Default: false

CCPPCHECK: If true, CCPPCHECK doesn't make MegaLinter fail even if errors are found

root C_CPPCHECK_DISABLE_ERRORS_IF_LESS_THAN

C_CPPCHECK: Maximum number of errors allowed

Type: number Default: 0

CCPPCHECK: If the number of errors found is less than this value, CCPPCHECK doesn't make MegaLinter fail

root C_CPPCHECK_FILE_EXTENSIONS

C_CPPCHECK: Matching files extensions

Type: array of string Default: [".c", ".h"]

C_CPPCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_FILE_EXTENSIONS C_CPPCHECK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root C_CPPCHECK_FILE_NAMES_REGEX

C_CPPCHECK: Matching file name regexes

Type: array of string Default: []

C_CPPCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_FILE_NAMES_REGEX C_CPPCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root C_CPPCHECK_FILTER_REGEX_EXCLUDE

C_CPPCHECK: Excluding Regex

Type: string

C_CPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

root C_CPPCHECK_FILTER_REGEX_INCLUDE

C_CPPCHECK: Including Regex

Type: string

C_CPPCHECK: Custom regex including filter: only files matching this regex will be linted

root C_CPPCHECK_POST_COMMANDS

C_CPPCHECK: Post-run commands

Type: array

CCPPCHECK: Define bash commands to run after running CCPPCHECK

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_POST_COMMANDS Command

Command

Type: object

Command information

root C_CPPCHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CPPCHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CPPCHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CPPCHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root C_CPPCHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CPPCHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CPPCHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CPPCHECK_PRE_COMMANDS

C_CPPCHECK: Pre-run commands

Type: array

CCPPCHECK: Define bash commands to run before running CCPPCHECK

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root C_CPPCHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CPPCHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CPPCHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CPPCHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root C_CPPCHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CPPCHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CPPCHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CPPCHECK_UNSECURED_ENV_VARIABLES

C_CPPCHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling C_CPPCHECK and its pre/post commands

 No Additional Items

Each item of this array must be:

root C_CPPCHECK_UNSECURED_ENV_VARIABLES C_CPPCHECK_UNSECURED_ENV_VARIABLES items
Type: string

root C_CPPLINT_ARGUMENTS

C_CPPLINT: Custom arguments

Type: array of string or string

C_CPPLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root C_CPPLINT_ARGUMENTS C_CPPLINT_ARGUMENTS items
Type: string

root C_CPPLINT_CLI_EXECUTABLE

C_CPPLINT: CLI Executable

Type: array of string Default: [["cpplint"]]

C_CPPLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root C_CPPLINT_CLI_EXECUTABLE C_CPPLINT_CLI_EXECUTABLE items
Type: string

root C_CPPLINT_CLI_LINT_MODE

C_CPPLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

C_CPPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root C_CPPLINT_COMMAND_REMOVE_ARGUMENTS

C_CPPLINT: Custom remove arguments

Type: array of string or string

C_CPPLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root C_CPPLINT_COMMAND_REMOVE_ARGUMENTS C_CPPLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root C_CPPLINT_DISABLE_ERRORS

C_CPPLINT: Disable errors

Type: boolean Default: false

CCPPLINT: If true, CCPPLINT doesn't make MegaLinter fail even if errors are found

root C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN

C_CPPLINT: Maximum number of errors allowed

Type: number Default: 0

CCPPLINT: If the number of errors found is less than this value, CCPPLINT doesn't make MegaLinter fail

root C_CPPLINT_FILE_EXTENSIONS

C_CPPLINT: Matching files extensions

Type: array of string Default: [".c", ".h"]

C_CPPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CPPLINT_FILE_EXTENSIONS C_CPPLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root C_CPPLINT_FILE_NAMES_REGEX

C_CPPLINT: Matching file name regexes

Type: array of string Default: []

C_CPPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root C_CPPLINT_FILE_NAMES_REGEX C_CPPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root C_CPPLINT_FILTER_REGEX_EXCLUDE

C_CPPLINT: Excluding Regex

Type: string

C_CPPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root C_CPPLINT_FILTER_REGEX_INCLUDE

C_CPPLINT: Including Regex

Type: string

C_CPPLINT: Custom regex including filter: only files matching this regex will be linted

root C_CPPLINT_POST_COMMANDS

C_CPPLINT: Post-run commands

Type: array

CCPPLINT: Define bash commands to run after running CCPPLINT

 No Additional Items

Each item of this array must be:

root C_CPPLINT_POST_COMMANDS Command

Command

Type: object

Command information

root C_CPPLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CPPLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CPPLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CPPLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CPPLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root C_CPPLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CPPLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CPPLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CPPLINT_PRE_COMMANDS

C_CPPLINT: Pre-run commands

Type: array

CCPPLINT: Define bash commands to run before running CCPPLINT

 No Additional Items

Each item of this array must be:

root C_CPPLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root C_CPPLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_CPPLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_CPPLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_CPPLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_CPPLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root C_CPPLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_CPPLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_CPPLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_CPPLINT_UNSECURED_ENV_VARIABLES

C_CPPLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling C_CPPLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root C_CPPLINT_UNSECURED_ENV_VARIABLES C_CPPLINT_UNSECURED_ENV_VARIABLES items
Type: string

root C_FILTER_REGEX_EXCLUDE

Excluding regex filter for C descriptor

Type: string

C: Custom regex excluding filter: files matching this regex will NOT be linted

root C_FILTER_REGEX_INCLUDE

Including regex filter for C descriptor

Type: string

C: Custom regex including filter: only files matching this regex will be linted

root C_POST_COMMANDS

Post commands for C descriptor

Type: array

C: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root C_POST_COMMANDS Command

Command

Type: object

Command information

root C_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_POST_COMMANDS Command output_variables output_variables items
Type: string

root C_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root C_PRE_COMMANDS

Pre commands for C descriptor

Type: array

C: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root C_PRE_COMMANDS Command

Command

Type: object

Command information

root C_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root C_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root C_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root C_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root C_PRE_COMMANDS Command output_variables output_variables items
Type: string

root C_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root C_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root C_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DART_DARTANALYZER_ARGUMENTS

DART_DARTANALYZER: Custom arguments

Type: array of string or string

DART_DARTANALYZER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_ARGUMENTS DART_DARTANALYZER_ARGUMENTS items
Type: string

root DART_DARTANALYZER_CLI_EXECUTABLE

DART_DARTANALYZER: CLI Executable

Type: array of string Default: [["dart"]]

DART_DARTANALYZER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_CLI_EXECUTABLE DART_DARTANALYZER_CLI_EXECUTABLE items
Type: string

root DART_DARTANALYZER_CLI_LINT_MODE

DART_DARTANALYZER: CLI lint mode

Type: enum (of string) Default: "file"

DART_DARTANALYZER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS

DART_DARTANALYZER: Custom remove arguments

Type: array of string or string

DART_DARTANALYZER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root DART_DARTANALYZER_CONFIG_FILE

DART_DARTANALYZER: Custom config file name

Type: string Default: "analysis_options.yaml"

DART_DARTANALYZER: User custom config file name if different from default

root DART_DARTANALYZER_DISABLE_ERRORS

DART_DARTANALYZER: Disable errors

Type: boolean Default: false

DARTDARTANALYZER: If true, DARTDARTANALYZER doesn't make MegaLinter fail even if errors are found

root DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN

DART_DARTANALYZER: Maximum number of errors allowed

Type: number Default: 0

DARTDARTANALYZER: If the number of errors found is less than this value, DARTDARTANALYZER doesn't make MegaLinter fail

root DART_DARTANALYZER_FILE_EXTENSIONS

DART_DARTANALYZER: Matching files extensions

Type: array of string Default: [".dart"]

DART_DARTANALYZER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_FILE_EXTENSIONS DART_DARTANALYZER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root DART_DARTANALYZER_FILE_NAMES_REGEX

DART_DARTANALYZER: Matching file name regexes

Type: array of string Default: []

DART_DARTANALYZER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_FILE_NAMES_REGEX DART_DARTANALYZER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root DART_DARTANALYZER_FILTER_REGEX_EXCLUDE

DART_DARTANALYZER: Excluding Regex

Type: string

DART_DARTANALYZER: Custom regex excluding filter: files matching this regex will NOT be linted

root DART_DARTANALYZER_FILTER_REGEX_INCLUDE

DART_DARTANALYZER: Including Regex

Type: string

DART_DARTANALYZER: Custom regex including filter: only files matching this regex will be linted

root DART_DARTANALYZER_POST_COMMANDS

DART_DARTANALYZER: Post-run commands

Type: array

DARTDARTANALYZER: Define bash commands to run after running DARTDARTANALYZER

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_POST_COMMANDS Command

Command

Type: object

Command information

root DART_DARTANALYZER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DART_DARTANALYZER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DART_DARTANALYZER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DART_DARTANALYZER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_POST_COMMANDS Command output_variables output_variables items
Type: string

root DART_DARTANALYZER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DART_DARTANALYZER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DART_DARTANALYZER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DART_DARTANALYZER_PRE_COMMANDS

DART_DARTANALYZER: Pre-run commands

Type: array

DARTDARTANALYZER: Define bash commands to run before running DARTDARTANALYZER

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_PRE_COMMANDS Command

Command

Type: object

Command information

root DART_DARTANALYZER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DART_DARTANALYZER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DART_DARTANALYZER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DART_DARTANALYZER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root DART_DARTANALYZER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DART_DARTANALYZER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DART_DARTANALYZER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DART_DARTANALYZER_RULES_PATH

DART_DARTANALYZER: Custom config file path

Type: string

DART_DARTANALYZER: Path where to find linter configuration file

root DART_DARTANALYZER_UNSECURED_ENV_VARIABLES

DART_DARTANALYZER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands

 No Additional Items

Each item of this array must be:

root DART_DARTANALYZER_UNSECURED_ENV_VARIABLES DART_DARTANALYZER_UNSECURED_ENV_VARIABLES items
Type: string

root DART_FILTER_REGEX_EXCLUDE

Excluding regex filter for DART descriptor

Type: string

DART: Custom regex excluding filter: files matching this regex will NOT be linted

root DART_FILTER_REGEX_INCLUDE

Including regex filter for DART descriptor

Type: string

DART: Custom regex including filter: only files matching this regex will be linted

root DART_POST_COMMANDS

Post commands for DART descriptor

Type: array

DART: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root DART_POST_COMMANDS Command

Command

Type: object

Command information

root DART_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DART_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DART_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DART_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DART_POST_COMMANDS Command output_variables output_variables items
Type: string

root DART_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DART_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DART_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DART_PRE_COMMANDS

Pre commands for DART descriptor

Type: array

DART: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root DART_PRE_COMMANDS Command

Command

Type: object

Command information

root DART_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DART_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DART_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DART_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DART_PRE_COMMANDS Command output_variables output_variables items
Type: string

root DART_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DART_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DART_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DEFAULT_BRANCH

Default git branch

Type: string Default: "HEAD"

Deprecated: The name of the repository's default branch.
Examples:

"master"

"main"

root DEFAULT_WORKSPACE

Default Workspace

Type: string Default: "/tmp/lint"

The location containing files to lint if you are running as docker image

root DISABLE

Disabled descriptor keys

Type: array

If DISABLE is set, the linters in the listed descriptors will be skipped

 No Additional Items

Each item of this array must be:

root DISABLE enum_descriptor_keys
Type: enum (of string)

Must be one of:

  • "ACTION"
  • "ANSIBLE"
  • "API"
  • "ARM"
  • "BASH"
  • "BICEP"
  • "C"
  • "CLOJURE"
  • "CLOUDFORMATION"
  • "COFFEE"
  • "COPYPASTE"
  • "CPP"
  • "CREDENTIALS"
  • "CSHARP"
  • "CSS"
  • "DART"
  • "DOCKERFILE"
  • "EDITORCONFIG"
  • "ENV"
  • "GHERKIN"
  • "GIT"
  • "GO"
  • "GRAPHQL"
  • "GROOVY"
  • "HTML"
  • "JAVA"
  • "JAVASCRIPT"
  • "JSON"
  • "JSX"
  • "KOTLIN"
  • "KUBERNETES"
  • "LATEX"
  • "LUA"
  • "MAKEFILE"
  • "MARKDOWN"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "REPOSITORY"
  • "ROBOTFRAMEWORK"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"

Example:

[
    "BASH",
    "HTML"
]

root DISABLE_ERRORS

Disable errors

Type: boolean Default: false

Flag to have the MegaLinter complete with exit code 0 even if errors were detected.

root DISABLE_ERRORS_LINTERS

Disabled errors linter keys

Type: array

If DISABLEERRORSLINTERS is set, the listed linters will be run but errors will be not blocking

 No Additional Items

Each item of this array must be:

root DISABLE_ERRORS_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

root DISABLE_LINTERS

Disabled linter keys

Type: array

If DISABLE_LINTERS is set, the listed linters will be skipped

 No Additional Items

Each item of this array must be:

root DISABLE_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

root DOCKERFILE_DOCKERFILELINT_ARGUMENTS

(removed) DOCKERFILE_DOCKERFILELINT: Custom arguments

Type: array of string or string

DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_ARGUMENTS DOCKERFILE_DOCKERFILELINT_ARGUMENTS items
Type: string

root DOCKERFILE_DOCKERFILELINT_CLI_LINT_MODE

(removed) DOCKERFILE_DOCKERFILELINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root DOCKERFILE_DOCKERFILELINT_CONFIG_FILE

(removed) DOCKERFILE_DOCKERFILELINT: Custom config file name

Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

root DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS

(removed) DOCKERFILE_DOCKERFILELINT: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

root DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS_IF_LESS_THAN

(removed) DOCKERFILE_DOCKERFILELINT: Maximum number of errors allowed

Type: number Default: 0

root DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS

(removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS items
Type: string

root DOCKERFILE_DOCKERFILELINT_FILE_NAME

(removed) DOCKERFILE_DOCKERFILELINT: Custom config file name

Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

root DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX

(removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_EXCLUDE

(removed) DOCKERFILE_DOCKERFILELINT: Excluding Regex

Type: string

root DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_INCLUDE

(removed) DOCKERFILE_DOCKERFILELINT: Including Regex

Type: string

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS

(removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS

(removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DOCKERFILE_DOCKERFILELINT_RULES_PATH

(removed) DOCKERFILE_DOCKERFILELINT: Custom config file path

Type: string

DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file

root DOCKERFILE_FILTER_REGEX_EXCLUDE

Excluding regex filter for DOCKERFILE descriptor

Type: string

DOCKERFILE: Custom regex excluding filter: files matching this regex will NOT be linted

root DOCKERFILE_FILTER_REGEX_INCLUDE

Including regex filter for DOCKERFILE descriptor

Type: string

DOCKERFILE: Custom regex including filter: only files matching this regex will be linted

root DOCKERFILE_HADOLINT_ARGUMENTS

DOCKERFILE_HADOLINT: Custom arguments

Type: array of string or string

DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_ARGUMENTS DOCKERFILE_HADOLINT_ARGUMENTS items
Type: string

root DOCKERFILE_HADOLINT_CLI_EXECUTABLE

DOCKERFILE_HADOLINT: CLI Executable

Type: array of string Default: [["hadolint"]]

DOCKERFILE_HADOLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_CLI_EXECUTABLE DOCKERFILE_HADOLINT_CLI_EXECUTABLE items
Type: string

root DOCKERFILE_HADOLINT_CLI_LINT_MODE

DOCKERFILE_HADOLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

DOCKERFILE_HADOLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS

DOCKERFILE_HADOLINT: Custom remove arguments

Type: array of string or string

DOCKERFILE_HADOLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root DOCKERFILE_HADOLINT_CONFIG_FILE

DOCKERFILE_HADOLINT: Custom config file name

Type: string Default: ".hadolint.yaml"

DOCKERFILE_HADOLINT: User custom config file name if different from default

root DOCKERFILE_HADOLINT_DISABLE_ERRORS

DOCKERFILE_HADOLINT: Disable errors

Type: boolean Default: false

DOCKERFILEHADOLINT: If true, DOCKERFILEHADOLINT doesn't make MegaLinter fail even if errors are found

root DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN

DOCKERFILE_HADOLINT: Maximum number of errors allowed

Type: number Default: 0

DOCKERFILEHADOLINT: If the number of errors found is less than this value, DOCKERFILEHADOLINT doesn't make MegaLinter fail

root DOCKERFILE_HADOLINT_FILE_EXTENSIONS

DOCKERFILE_HADOLINT: Matching files extensions

Type: array of string Default: []

DOCKERFILE_HADOLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_FILE_EXTENSIONS DOCKERFILE_HADOLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root DOCKERFILE_HADOLINT_FILE_NAMES_REGEX

DOCKERFILE_HADOLINT: Matching file name regexes

Type: array of string Default: ["Containerfile", "(.*\\.)?Dockerfile"]

DOCKERFILE_HADOLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_FILE_NAMES_REGEX DOCKERFILE_HADOLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE

DOCKERFILE_HADOLINT: Excluding Regex

Type: string

DOCKERFILE_HADOLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE

DOCKERFILE_HADOLINT: Including Regex

Type: string

DOCKERFILE_HADOLINT: Custom regex including filter: only files matching this regex will be linted

root DOCKERFILE_HADOLINT_POST_COMMANDS

DOCKERFILE_HADOLINT: Post-run commands

Type: array

DOCKERFILEHADOLINT: Define bash commands to run after running DOCKERFILEHADOLINT

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_POST_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_HADOLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_HADOLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_HADOLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_HADOLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_HADOLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_HADOLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_HADOLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DOCKERFILE_HADOLINT_PRE_COMMANDS

DOCKERFILE_HADOLINT: Pre-run commands

Type: array

DOCKERFILEHADOLINT: Define bash commands to run before running DOCKERFILEHADOLINT

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_HADOLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DOCKERFILE_HADOLINT_RULES_PATH

DOCKERFILE_HADOLINT: Custom config file path

Type: string

DOCKERFILE_HADOLINT: Path where to find linter configuration file

root DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES

DOCKERFILE_HADOLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling DOCKERFILE_HADOLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES items
Type: string

root DOCKERFILE_POST_COMMANDS

Post commands for DOCKERFILE descriptor

Type: array

DOCKERFILE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root DOCKERFILE_POST_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_POST_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root DOCKERFILE_PRE_COMMANDS

Pre commands for DOCKERFILE descriptor

Type: array

DOCKERFILE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root DOCKERFILE_PRE_COMMANDS Command

Command

Type: object

Command information

root DOCKERFILE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root DOCKERFILE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root DOCKERFILE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root DOCKERFILE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root DOCKERFILE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root DOCKERFILE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root DOCKERFILE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root DOCKERFILE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom arguments

Type: array of string or string

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE

EDITORCONFIG_EDITORCONFIG_CHECKER: CLI Executable

Type: array of string Default: [["editorconfig-checker"]]

EDITORCONFIGEDITORCONFIGCHECKER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE

EDITORCONFIG_EDITORCONFIG_CHECKER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

EDITORCONFIGEDITORCONFIGCHECKER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom remove arguments

Type: array of string or string

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file name

Type: string Default: ".editorconfig-checker.json"

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

root EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS

EDITORCONFIG_EDITORCONFIG_CHECKER: Disable errors

Type: boolean Default: false

EDITORCONFIGEDITORCONFIGCHECKER: If true, EDITORCONFIGEDITORCONFIGCHECKER doesn't make MegaLinter fail even if errors are found

root EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN

EDITORCONFIG_EDITORCONFIG_CHECKER: Maximum number of errors allowed

Type: number Default: 0

EDITORCONFIGEDITORCONFIGCHECKER: If the number of errors found is less than this value, EDITORCONFIGEDITORCONFIGCHECKER doesn't make MegaLinter fail

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS

EDITORCONFIG_EDITORCONFIG_CHECKER: Matching files extensions

Type: array of string Default: ["*"]

EDITORCONFIGEDITORCONFIGCHECKER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX

EDITORCONFIG_EDITORCONFIG_CHECKER: Matching file name regexes

Type: array of string Default: []

EDITORCONFIGEDITORCONFIGCHECKER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE

EDITORCONFIG_EDITORCONFIG_CHECKER: Excluding Regex

Type: string

EDITORCONFIGEDITORCONFIGCHECKER: Custom regex excluding filter: files matching this regex will NOT be linted

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE

EDITORCONFIG_EDITORCONFIG_CHECKER: Including Regex

Type: string

EDITORCONFIGEDITORCONFIGCHECKER: Custom regex including filter: only files matching this regex will be linted

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS

EDITORCONFIG_EDITORCONFIG_CHECKER: Post-run commands

Type: array

EDITORCONFIGEDITORCONFIGCHECKER: Define bash commands to run after running EDITORCONFIGEDITORCONFIGCHECKER

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command

Command

Type: object

Command information

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command output_variables output_variables items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS

EDITORCONFIG_EDITORCONFIG_CHECKER: Pre-run commands

Type: array

EDITORCONFIGEDITORCONFIGCHECKER: Define bash commands to run before running EDITORCONFIGEDITORCONFIGCHECKER

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command

Command

Type: object

Command information

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file path

Type: string

EDITORCONFIGEDITORCONFIGCHECKER: Path where to find linter configuration file

root EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES

EDITORCONFIG_EDITORCONFIG_CHECKER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling EDITORCONFIGEDITORCONFIGCHECKER and its pre/post commands

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES items
Type: string

root EDITORCONFIG_FILTER_REGEX_EXCLUDE

Excluding regex filter for EDITORCONFIG descriptor

Type: string

EDITORCONFIG: Custom regex excluding filter: files matching this regex will NOT be linted

root EDITORCONFIG_FILTER_REGEX_INCLUDE

Including regex filter for EDITORCONFIG descriptor

Type: string

EDITORCONFIG: Custom regex including filter: only files matching this regex will be linted

root EDITORCONFIG_POST_COMMANDS

Post commands for EDITORCONFIG descriptor

Type: array

EDITORCONFIG: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_POST_COMMANDS Command

Command

Type: object

Command information

root EDITORCONFIG_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root EDITORCONFIG_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root EDITORCONFIG_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root EDITORCONFIG_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_POST_COMMANDS Command output_variables output_variables items
Type: string

root EDITORCONFIG_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root EDITORCONFIG_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root EDITORCONFIG_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root EDITORCONFIG_PRE_COMMANDS

Pre commands for EDITORCONFIG descriptor

Type: array

EDITORCONFIG: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_PRE_COMMANDS Command

Command

Type: object

Command information

root EDITORCONFIG_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root EDITORCONFIG_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root EDITORCONFIG_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root EDITORCONFIG_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root EDITORCONFIG_PRE_COMMANDS Command output_variables output_variables items
Type: string

root EDITORCONFIG_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root EDITORCONFIG_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root EDITORCONFIG_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root EMAIL_REPORTER

Activate Email reporter

Type: boolean Default: true

MegaLinter can send email with reports to given addresses. Please set EMAILREPORTER** variables if activated

root EMAIL_REPORTER_EMAIL

Email reporter: E-mail addresses

Type: string

Comma-separated list of recipient emails, that will receive reports

root EMAIL_REPORTER_SENDER

Email reporter: Sender of emails

Type: string Default: "megalinter@gmail.com"

root EMAIL_REPORTER_SEND_SUCCESS

Send email reports even when success

Type: boolean Default: false

Define to true if you want to receive reports by mail even when there is no errors or updated sources

root EMAIL_REPORTER_SMTP_HOST

Email reporter: SMTP server host

Type: string Default: "smtp.gmail.com"

root EMAIL_REPORTER_SMTP_PASSWORD

Email reporter: SMTP server password. Never hardcode it in a config variable, use secrets and context variables

Type: string

root EMAIL_REPORTER_SMTP_PORT

Email reporter: SMTP server port

Type: number Default: "465"

root EMAIL_REPORTER_SMTP_USERNAME

Email reporter: SMTP username

Type: string Default: "megalinter@gmail.com"

root ENABLE

Enabled descriptor keys

Type: array

If ENABLE is not set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default

 No Additional Items

Each item of this array must be:

root ENABLE enum_descriptor_keys
Type: enum (of string)

Must be one of:

  • "ACTION"
  • "ANSIBLE"
  • "API"
  • "ARM"
  • "BASH"
  • "BICEP"
  • "C"
  • "CLOJURE"
  • "CLOUDFORMATION"
  • "COFFEE"
  • "COPYPASTE"
  • "CPP"
  • "CREDENTIALS"
  • "CSHARP"
  • "CSS"
  • "DART"
  • "DOCKERFILE"
  • "EDITORCONFIG"
  • "ENV"
  • "GHERKIN"
  • "GIT"
  • "GO"
  • "GRAPHQL"
  • "GROOVY"
  • "HTML"
  • "JAVA"
  • "JAVASCRIPT"
  • "JSON"
  • "JSX"
  • "KOTLIN"
  • "KUBERNETES"
  • "LATEX"
  • "LUA"
  • "MAKEFILE"
  • "MARKDOWN"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "REPOSITORY"
  • "ROBOTFRAMEWORK"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"

Example:

[
    "BASH",
    "HTML",
    "JAVASCRIPT"
]

root ENABLE_ERRORS_LINTERS

Enabled errors linter keys

Type: array

If ENABLEERRORSLINTERS is set, only the listed linters will be considered as blocking

 No Additional Items

Each item of this array must be:

root ENABLE_ERRORS_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "REPOSITORY_TRIVY",
    "REPOSITORY_GITLEAKS"
]

root ENABLE_LINTERS

Enabled linter keys

Type: array

If ENABLE_LINTERS is set, only listed linters will be processed

 No Additional Items

Each item of this array must be:

root ENABLE_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

root ENV_DOTENV_LINTER_ARGUMENTS

ENV_DOTENV_LINTER: Custom arguments

Type: array of string or string

ENVDOTENVLINTER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_ARGUMENTS ENV_DOTENV_LINTER_ARGUMENTS items
Type: string

root ENV_DOTENV_LINTER_CLI_EXECUTABLE

ENV_DOTENV_LINTER: CLI Executable

Type: array of string Default: [["dotenv-linter"]]

ENVDOTENVLINTER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_CLI_EXECUTABLE ENV_DOTENV_LINTER_CLI_EXECUTABLE items
Type: string

root ENV_DOTENV_LINTER_CLI_LINT_MODE

ENV_DOTENV_LINTER: CLI lint mode

Type: enum (of string) Default: "file"

ENVDOTENVLINTER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS

ENV_DOTENV_LINTER: Custom remove arguments

Type: array of string or string

ENVDOTENVLINTER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root ENV_DOTENV_LINTER_DISABLE_ERRORS

ENV_DOTENV_LINTER: Disable errors

Type: boolean Default: false

ENVDOTENVLINTER: If true, ENVDOTENVLINTER doesn't make MegaLinter fail even if errors are found

root ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN

ENV_DOTENV_LINTER: Maximum number of errors allowed

Type: number Default: 0

ENVDOTENVLINTER: If the number of errors found is less than this value, ENVDOTENVLINTER doesn't make MegaLinter fail

root ENV_DOTENV_LINTER_FILE_EXTENSIONS

ENV_DOTENV_LINTER: Matching files extensions

Type: array of string Default: [".env"]

ENVDOTENVLINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_FILE_EXTENSIONS ENV_DOTENV_LINTER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root ENV_DOTENV_LINTER_FILE_NAMES_REGEX

ENV_DOTENV_LINTER: Matching file name regexes

Type: array of string Default: []

ENVDOTENVLINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_FILE_NAMES_REGEX ENV_DOTENV_LINTER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE

ENV_DOTENV_LINTER: Excluding Regex

Type: string

ENVDOTENVLINTER: Custom regex excluding filter: files matching this regex will NOT be linted

root ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE

ENV_DOTENV_LINTER: Including Regex

Type: string

ENVDOTENVLINTER: Custom regex including filter: only files matching this regex will be linted

root ENV_DOTENV_LINTER_POST_COMMANDS

ENV_DOTENV_LINTER: Post-run commands

Type: array

ENVDOTENVLINTER: Define bash commands to run after running ENVDOTENVLINTER

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_POST_COMMANDS Command

Command

Type: object

Command information

root ENV_DOTENV_LINTER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ENV_DOTENV_LINTER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ENV_DOTENV_LINTER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ENV_DOTENV_LINTER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_POST_COMMANDS Command output_variables output_variables items
Type: string

root ENV_DOTENV_LINTER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ENV_DOTENV_LINTER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ENV_DOTENV_LINTER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ENV_DOTENV_LINTER_PRE_COMMANDS

ENV_DOTENV_LINTER: Pre-run commands

Type: array

ENVDOTENVLINTER: Define bash commands to run before running ENVDOTENVLINTER

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_PRE_COMMANDS Command

Command

Type: object

Command information

root ENV_DOTENV_LINTER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ENV_DOTENV_LINTER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ENV_DOTENV_LINTER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ENV_DOTENV_LINTER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ENV_DOTENV_LINTER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ENV_DOTENV_LINTER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ENV_DOTENV_LINTER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES

ENV_DOTENV_LINTER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ENVDOTENVLINTER and its pre/post commands

 No Additional Items

Each item of this array must be:

root ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES items
Type: string

root ENV_FILTER_REGEX_EXCLUDE

Excluding regex filter for ENV descriptor

Type: string

ENV: Custom regex excluding filter: files matching this regex will NOT be linted

root ENV_FILTER_REGEX_INCLUDE

Including regex filter for ENV descriptor

Type: string

ENV: Custom regex including filter: only files matching this regex will be linted

root ENV_POST_COMMANDS

Post commands for ENV descriptor

Type: array

ENV: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root ENV_POST_COMMANDS Command

Command

Type: object

Command information

root ENV_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ENV_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ENV_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ENV_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ENV_POST_COMMANDS Command output_variables output_variables items
Type: string

root ENV_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ENV_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ENV_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ENV_PRE_COMMANDS

Pre commands for ENV descriptor

Type: array

ENV: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root ENV_PRE_COMMANDS Command

Command

Type: object

Command information

root ENV_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ENV_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ENV_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ENV_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ENV_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ENV_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ENV_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ENV_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ERROR_ON_MISSING_EXEC_BIT

Disable errors for BASH-EXEC

Type: boolean Default: false

If set to false, the bash-exec linter will report a warning if a shell script is not executable. If set to true, the bash-exec linter will report an error instead

root EXCLUDED_DIRECTORIES

Excluded directories

Type: array of string

List of excluded directory basenames replacing MegaLinter default excluded directories. They are excluded at any nested level.

 No Additional Items

Each item of this array must be:

root EXCLUDED_DIRECTORIES EXCLUDED_DIRECTORIES items
Type: string

Example:

[
    ".github",
    "node_modules"
]

root EXTENDS

MegaLinter config files to extend from

Type: array of string or string

Base mega-linter.yml config file(s) to extend local configuration from. Can be a single URL or a list of .mega-linter.yml config files URLs

 No Additional Items

Each item of this array must be:

root EXTENDS EXTENDS items
Type: string

root FAIL_IF_MISSING_LINTER_IN_FLAVOR

Fail if missing linter

Type: boolean Default: false

If set to true, MegaLinter fails if a linter is missing in the selected flavor

root FAIL_IF_UPDATED_SOURCES

Fail if updated sources

Type: boolean Default: false

If set to true, MegaLinter fails if a linter or formatter has auto-fixed sources, even if there are no errors

root FILEIO_REPORTER

Activate File.io reporter

Type: boolean Default: false

If you don't use artifacts upload to read MegaLinter reports, you can access them with an hyperlink to file.io. Important: MegaLinter has no affiliation with file.io, but it's supposed to be secured, and only one download is available for a report (snapchat for files, basically)

root FILEIO_REPORTER_SEND_SUCCESS

Skip file.io if success

Type: boolean Default: false

Skip posting to file.io if linting is in success

root FILTER_REGEX_EXCLUDE

Excluding regex filter

Type: string

Regular expression defining which files will be excluded from linting
Examples:

"(\\.automation/test|docs/javascripts|docs/overrides|flavors|clj-kondo|TEMPLATES)"

"(src/test)"

root FILTER_REGEX_INCLUDE

Including regex filter

Type: string

Regular expression defining which files will be processed by linters
Example:

"(src/)"

root FLAVOR_SUGGESTIONS

Flavor suggestions

Type: boolean Default: true

Provides suggestions about different MegaLinter flavors to use to improve runtime performances

root FORMATTERS_DISABLE_ERRORS

Disable errors when linter is a formatter

Type: boolean Default: true

Formatter errors will be reported as errors (and not warnings) if this variable is set to false

root GHERKIN_FILTER_REGEX_EXCLUDE

Excluding regex filter for GHERKIN descriptor

Type: string

GHERKIN: Custom regex excluding filter: files matching this regex will NOT be linted

root GHERKIN_FILTER_REGEX_INCLUDE

Including regex filter for GHERKIN descriptor

Type: string

GHERKIN: Custom regex including filter: only files matching this regex will be linted

root GHERKIN_GHERKIN_LINT_ARGUMENTS

GHERKIN_GHERKIN_LINT: Custom arguments

Type: array of string or string

GHERKINGHERKINLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_ARGUMENTS GHERKIN_GHERKIN_LINT_ARGUMENTS items
Type: string

root GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE

GHERKIN_GHERKIN_LINT: CLI Executable

Type: array of string Default: [["gherkin-lint"]]

GHERKINGHERKINLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE items
Type: string

root GHERKIN_GHERKIN_LINT_CLI_LINT_MODE

GHERKIN_GHERKIN_LINT: CLI lint mode

Type: enum (of string) Default: "file"

GHERKINGHERKINLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS

GHERKIN_GHERKIN_LINT: Custom remove arguments

Type: array of string or string

GHERKINGHERKINLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root GHERKIN_GHERKIN_LINT_CONFIG_FILE

GHERKIN_GHERKIN_LINT: Custom config file name

Type: string Default: ".gherkin-lintrc"

GHERKINGHERKINLINT: User custom config file name if different from default

root GHERKIN_GHERKIN_LINT_DISABLE_ERRORS

GHERKIN_GHERKIN_LINT: Disable errors

Type: boolean Default: false

GHERKINGHERKINLINT: If true, GHERKINGHERKINLINT doesn't make MegaLinter fail even if errors are found

root GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN

GHERKIN_GHERKIN_LINT: Maximum number of errors allowed

Type: number Default: 0

GHERKINGHERKINLINT: If the number of errors found is less than this value, GHERKINGHERKINLINT doesn't make MegaLinter fail

root GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS

GHERKIN_GHERKIN_LINT: Matching files extensions

Type: array of string Default: [".feature"]

GHERKINGHERKINLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX

GHERKIN_GHERKIN_LINT: Matching file name regexes

Type: array of string Default: []

GHERKINGHERKINLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE

GHERKIN_GHERKIN_LINT: Excluding Regex

Type: string

GHERKINGHERKINLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE

GHERKIN_GHERKIN_LINT: Including Regex

Type: string

GHERKINGHERKINLINT: Custom regex including filter: only files matching this regex will be linted

root GHERKIN_GHERKIN_LINT_POST_COMMANDS

GHERKIN_GHERKIN_LINT: Post-run commands

Type: array

GHERKINGHERKINLINT: Define bash commands to run after running GHERKINGHERKINLINT

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GHERKIN_GHERKIN_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS

GHERKIN_GHERKIN_LINT: Pre-run commands

Type: array

GHERKINGHERKINLINT: Define bash commands to run before running GHERKINGHERKINLINT

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GHERKIN_GHERKIN_LINT_RULES_PATH

GHERKIN_GHERKIN_LINT: Custom config file path

Type: string

GHERKINGHERKINLINT: Path where to find linter configuration file

root GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES

GHERKIN_GHERKIN_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling GHERKINGHERKINLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root GHERKIN_POST_COMMANDS

Post commands for GHERKIN descriptor

Type: array

GHERKIN: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root GHERKIN_POST_COMMANDS Command

Command

Type: object

Command information

root GHERKIN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GHERKIN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GHERKIN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GHERKIN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GHERKIN_POST_COMMANDS Command output_variables output_variables items
Type: string

root GHERKIN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GHERKIN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GHERKIN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GHERKIN_PRE_COMMANDS

Pre commands for GHERKIN descriptor

Type: array

GHERKIN: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root GHERKIN_PRE_COMMANDS Command

Command

Type: object

Command information

root GHERKIN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GHERKIN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GHERKIN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GHERKIN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GHERKIN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GHERKIN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GHERKIN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GHERKIN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GITHUB_API_URL

GitHub API base URL

Type: stringFormat: uri Default: "https://api.github.com"

URL where the github API can be reached. Must be overridden if using GitHub Enterprise
Example:

"https://github.my-company.com/api/v3"

root GITHUB_COMMENT_REPORTER

Activate GitHub PR Comments reporter

Type: boolean Default: true

Posts MegaLinter results summary in the comments of the related pull request (if existing)

root GITHUB_SERVER_URL

GitHub server base URL

Type: stringFormat: uri Default: "https://github.com"

URL of the GitHub instance. Must be overridden if using GitHub Enterprise
Example:

"https://github.my-company.com/"

root GITHUB_STATUS_REPORTER

Activate GitHub Status reporter

Type: boolean Default: true

Posts a status on the pull request for each processed linter

root GITHUB_WORKSPACE

GitHub Workspace

Type: string Default: "/tmp/lint"

Base directory for REPORTOUTPUTFOLDER, for user-defined linter rules location, for location of linted files if DEFAULT_WORKSPACE is not set

root GITLAB_CERTIFICATE_PATH

Gitlab SSL Certificate path

Type: string Default: true

Path to SSL certificate if necessary

root GITLAB_COMMENT_REPORTER

Activate Gitlab MR Comments reporter

Type: boolean Default: true

Posts Mega-Linter results summary in the comments of the related merge request (if existing)

root GITLAB_COMMENT_REPORTER_OVERWRITE_COMMENT

Overwrite Gitlab Merge Request Comment

Type: boolean Default: true

Set to false to disable the overwrite of existing MegaLinter Merge Request comment in case of new run

root GO_FILTER_REGEX_EXCLUDE

Excluding regex filter for GO descriptor

Type: string

GO: Custom regex excluding filter: files matching this regex will NOT be linted

root GO_FILTER_REGEX_INCLUDE

Including regex filter for GO descriptor

Type: string

GO: Custom regex including filter: only files matching this regex will be linted

root GO_GOLANGCI_LINT_ARGUMENTS

GO_GOLANGCI_LINT: Custom arguments

Type: array of string or string

GOGOLANGCILINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_ARGUMENTS GO_GOLANGCI_LINT_ARGUMENTS items
Type: string

root GO_GOLANGCI_LINT_CLI_EXECUTABLE

GO_GOLANGCI_LINT: CLI Executable

Type: array of string Default: [["golangci-lint"]]

GOGOLANGCILINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_CLI_EXECUTABLE GO_GOLANGCI_LINT_CLI_EXECUTABLE items
Type: string

root GO_GOLANGCI_LINT_CLI_LINT_MODE

GO_GOLANGCI_LINT: CLI lint mode

Type: enum (of string) Default: "project"

GOGOLANGCILINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS

GO_GOLANGCI_LINT: Custom remove arguments

Type: array of string or string

GOGOLANGCILINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root GO_GOLANGCI_LINT_CONFIG_FILE

GO_GOLANGCI_LINT: Custom config file name

Type: string Default: ".golangci.yml"

GOGOLANGCILINT: User custom config file name if different from default

root GO_GOLANGCI_LINT_DISABLE_ERRORS

GO_GOLANGCI_LINT: Disable errors

Type: boolean Default: false

GOGOLANGCILINT: If true, GOGOLANGCILINT doesn't make MegaLinter fail even if errors are found

root GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN

GO_GOLANGCI_LINT: Maximum number of errors allowed

Type: number Default: 0

GOGOLANGCILINT: If the number of errors found is less than this value, GOGOLANGCILINT doesn't make MegaLinter fail

root GO_GOLANGCI_LINT_FILE_EXTENSIONS

GO_GOLANGCI_LINT: Matching files extensions

Type: array of string Default: [".go"]

GOGOLANGCILINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_FILE_EXTENSIONS GO_GOLANGCI_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root GO_GOLANGCI_LINT_FILE_NAMES_REGEX

GO_GOLANGCI_LINT: Matching file name regexes

Type: array of string Default: []

GOGOLANGCILINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_FILE_NAMES_REGEX GO_GOLANGCI_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root GO_GOLANGCI_LINT_POST_COMMANDS

GO_GOLANGCI_LINT: Post-run commands

Type: array

GOGOLANGCILINT: Define bash commands to run after running GOGOLANGCILINT

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root GO_GOLANGCI_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_GOLANGCI_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_GOLANGCI_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_GOLANGCI_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root GO_GOLANGCI_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_GOLANGCI_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_GOLANGCI_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_GOLANGCI_LINT_PRE_COMMANDS

GO_GOLANGCI_LINT: Pre-run commands

Type: array

GOGOLANGCILINT: Define bash commands to run before running GOGOLANGCILINT

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root GO_GOLANGCI_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_GOLANGCI_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_GOLANGCI_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_GOLANGCI_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GO_GOLANGCI_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_GOLANGCI_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_GOLANGCI_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_GOLANGCI_LINT_RULES_PATH

GO_GOLANGCI_LINT: Custom config file path

Type: string

GOGOLANGCILINT: Path where to find linter configuration file

root GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES

GO_GOLANGCI_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling GOGOLANGCILINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root GO_POST_COMMANDS

Post commands for GO descriptor

Type: array

GO: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root GO_POST_COMMANDS Command

Command

Type: object

Command information

root GO_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_POST_COMMANDS Command output_variables output_variables items
Type: string

root GO_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_PRE_COMMANDS

Pre commands for GO descriptor

Type: array

GO: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root GO_PRE_COMMANDS Command

Command

Type: object

Command information

root GO_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GO_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_REVIVE_ARGUMENTS

GO_REVIVE: Custom arguments

Type: array of string or string

GO_REVIVE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root GO_REVIVE_ARGUMENTS GO_REVIVE_ARGUMENTS items
Type: string

root GO_REVIVE_CLI_EXECUTABLE

GO_REVIVE: CLI Executable

Type: array of string Default: [["revive"]]

GO_REVIVE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root GO_REVIVE_CLI_EXECUTABLE GO_REVIVE_CLI_EXECUTABLE items
Type: string

root GO_REVIVE_CLI_LINT_MODE

GO_REVIVE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

GO_REVIVE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root GO_REVIVE_COMMAND_REMOVE_ARGUMENTS

GO_REVIVE: Custom remove arguments

Type: array of string or string

GO_REVIVE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root GO_REVIVE_COMMAND_REMOVE_ARGUMENTS GO_REVIVE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root GO_REVIVE_CONFIG_FILE

GO_REVIVE: Custom config file name

Type: string Default: "revive.toml"

GO_REVIVE: User custom config file name if different from default

root GO_REVIVE_DISABLE_ERRORS

GO_REVIVE: Disable errors

Type: boolean Default: false

GOREVIVE: If true, GOREVIVE doesn't make MegaLinter fail even if errors are found

root GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN

GO_REVIVE: Maximum number of errors allowed

Type: number Default: 0

GOREVIVE: If the number of errors found is less than this value, GOREVIVE doesn't make MegaLinter fail

root GO_REVIVE_FILE_EXTENSIONS

GO_REVIVE: Matching files extensions

Type: array of string Default: [".go"]

GO_REVIVE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GO_REVIVE_FILE_EXTENSIONS GO_REVIVE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root GO_REVIVE_FILE_NAMES_REGEX

GO_REVIVE: Matching file name regexes

Type: array of string Default: []

GO_REVIVE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GO_REVIVE_FILE_NAMES_REGEX GO_REVIVE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root GO_REVIVE_FILTER_REGEX_EXCLUDE

GO_REVIVE: Excluding Regex

Type: string

GO_REVIVE: Custom regex excluding filter: files matching this regex will NOT be linted

root GO_REVIVE_FILTER_REGEX_INCLUDE

GO_REVIVE: Including Regex

Type: string

GO_REVIVE: Custom regex including filter: only files matching this regex will be linted

root GO_REVIVE_POST_COMMANDS

GO_REVIVE: Post-run commands

Type: array

GOREVIVE: Define bash commands to run after running GOREVIVE

 No Additional Items

Each item of this array must be:

root GO_REVIVE_POST_COMMANDS Command

Command

Type: object

Command information

root GO_REVIVE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_REVIVE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_REVIVE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_REVIVE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_REVIVE_POST_COMMANDS Command output_variables output_variables items
Type: string

root GO_REVIVE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_REVIVE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_REVIVE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_REVIVE_PRE_COMMANDS

GO_REVIVE: Pre-run commands

Type: array

GOREVIVE: Define bash commands to run before running GOREVIVE

 No Additional Items

Each item of this array must be:

root GO_REVIVE_PRE_COMMANDS Command

Command

Type: object

Command information

root GO_REVIVE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GO_REVIVE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GO_REVIVE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GO_REVIVE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GO_REVIVE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GO_REVIVE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GO_REVIVE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GO_REVIVE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GO_REVIVE_RULES_PATH

GO_REVIVE: Custom config file path

Type: string

GO_REVIVE: Path where to find linter configuration file

root GO_REVIVE_UNSECURED_ENV_VARIABLES

GO_REVIVE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling GO_REVIVE and its pre/post commands

 No Additional Items

Each item of this array must be:

root GO_REVIVE_UNSECURED_ENV_VARIABLES GO_REVIVE_UNSECURED_ENV_VARIABLES items
Type: string

root GRAPHQL_FILTER_REGEX_EXCLUDE

Excluding regex filter for GRAPHQL descriptor

Type: string

GRAPHQL: Custom regex excluding filter: files matching this regex will NOT be linted

root GRAPHQL_FILTER_REGEX_INCLUDE

Including regex filter for GRAPHQL descriptor

Type: string

GRAPHQL: Custom regex including filter: only files matching this regex will be linted

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom arguments

Type: array of string or string

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS items
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE

GRAPHQL_GRAPHQL_SCHEMA_LINTER: CLI Executable

Type: array of string Default: [["graphql-schema-linter"]]

GRAPHQLGRAPHQLSCHEMA_LINTER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE items
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE

GRAPHQL_GRAPHQL_SCHEMA_LINTER: CLI lint mode

Type: enum (of string) Default: "file"

GRAPHQLGRAPHQLSCHEMA_LINTER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom remove arguments

Type: array of string or string

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file name

Type: string Default: ".graphql-schema-linterrc"

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Disable errors

Type: boolean Default: false

GRAPHQLGRAPHQLSCHEMALINTER: If true, GRAPHQLGRAPHQLSCHEMALINTER doesn't make MegaLinter fail even if errors are found

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Maximum number of errors allowed

Type: number Default: 0

GRAPHQLGRAPHQLSCHEMALINTER: If the number of errors found is less than this value, GRAPHQLGRAPHQLSCHEMALINTER doesn't make MegaLinter fail

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Matching files extensions

Type: array of string Default: [".graphql"]

GRAPHQLGRAPHQLSCHEMA_LINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Matching file name regexes

Type: array of string Default: []

GRAPHQLGRAPHQLSCHEMA_LINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Excluding Regex

Type: string

GRAPHQLGRAPHQLSCHEMA_LINTER: Custom regex excluding filter: files matching this regex will NOT be linted

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Including Regex

Type: string

GRAPHQLGRAPHQLSCHEMA_LINTER: Custom regex including filter: only files matching this regex will be linted

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Post-run commands

Type: array

GRAPHQLGRAPHQLSCHEMALINTER: Define bash commands to run after running GRAPHQLGRAPHQLSCHEMALINTER

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command

Command

Type: object

Command information

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command output_variables output_variables items
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Pre-run commands

Type: array

GRAPHQLGRAPHQLSCHEMALINTER: Define bash commands to run before running GRAPHQLGRAPHQLSCHEMALINTER

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command

Command

Type: object

Command information

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file path

Type: string

GRAPHQLGRAPHQLSCHEMA_LINTER: Path where to find linter configuration file

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling GRAPHQLGRAPHQLSCHEMA_LINTER and its pre/post commands

 No Additional Items

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES items
Type: string

root GRAPHQL_POST_COMMANDS

Post commands for GRAPHQL descriptor

Type: array

GRAPHQL: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root GRAPHQL_POST_COMMANDS Command

Command

Type: object

Command information

root GRAPHQL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GRAPHQL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GRAPHQL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GRAPHQL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GRAPHQL_POST_COMMANDS Command output_variables output_variables items
Type: string

root GRAPHQL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GRAPHQL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GRAPHQL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GRAPHQL_PRE_COMMANDS

Pre commands for GRAPHQL descriptor

Type: array

GRAPHQL: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root GRAPHQL_PRE_COMMANDS Command

Command

Type: object

Command information

root GRAPHQL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GRAPHQL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GRAPHQL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GRAPHQL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GRAPHQL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GRAPHQL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GRAPHQL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GRAPHQL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GROOVY_FILTER_REGEX_EXCLUDE

Excluding regex filter for GROOVY descriptor

Type: string

GROOVY: Custom regex excluding filter: files matching this regex will NOT be linted

root GROOVY_FILTER_REGEX_INCLUDE

Including regex filter for GROOVY descriptor

Type: string

GROOVY: Custom regex including filter: only files matching this regex will be linted

root GROOVY_NPM_GROOVY_LINT_ARGUMENTS

GROOVY_NPM_GROOVY_LINT: Custom arguments

Type: array of string or string

GROOVYNPMGROOVY_LINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_ARGUMENTS GROOVY_NPM_GROOVY_LINT_ARGUMENTS items
Type: string

root GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE

GROOVY_NPM_GROOVY_LINT: CLI Executable

Type: array of string Default: [["npm-groovy-lint"]]

GROOVYNPMGROOVY_LINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE items
Type: string

root GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE

GROOVY_NPM_GROOVY_LINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

GROOVYNPMGROOVY_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS

GROOVY_NPM_GROOVY_LINT: Custom remove arguments

Type: array of string or string

GROOVYNPMGROOVY_LINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root GROOVY_NPM_GROOVY_LINT_CONFIG_FILE

GROOVY_NPM_GROOVY_LINT: Custom config file name

Type: string Default: ".groovylintrc.json"

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

root GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS

GROOVY_NPM_GROOVY_LINT: Disable errors

Type: boolean Default: false

GROOVYNPMGROOVYLINT: If true, GROOVYNPMGROOVYLINT doesn't make MegaLinter fail even if errors are found

root GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN

GROOVY_NPM_GROOVY_LINT: Maximum number of errors allowed

Type: number Default: 0

GROOVYNPMGROOVYLINT: If the number of errors found is less than this value, GROOVYNPMGROOVYLINT doesn't make MegaLinter fail

root GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS

GROOVY_NPM_GROOVY_LINT: Matching files extensions

Type: array of string Default: [".groovy", ".gvy", ".gradle", ".nf"]

GROOVYNPMGROOVY_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX

GROOVY_NPM_GROOVY_LINT: Matching file name regexes

Type: array of string Default: ["Jenkinsfile"]

GROOVYNPMGROOVY_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE

GROOVY_NPM_GROOVY_LINT: Excluding Regex

Type: string

GROOVYNPMGROOVY_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

root GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE

GROOVY_NPM_GROOVY_LINT: Including Regex

Type: string

GROOVYNPMGROOVY_LINT: Custom regex including filter: only files matching this regex will be linted

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS

GROOVY_NPM_GROOVY_LINT: Post-run commands

Type: array

GROOVYNPMGROOVYLINT: Define bash commands to run after running GROOVYNPMGROOVYLINT

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS

GROOVY_NPM_GROOVY_LINT: Pre-run commands

Type: array

GROOVYNPMGROOVYLINT: Define bash commands to run before running GROOVYNPMGROOVYLINT

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GROOVY_NPM_GROOVY_LINT_RULES_PATH

GROOVY_NPM_GROOVY_LINT: Custom config file path

Type: string

GROOVYNPMGROOVY_LINT: Path where to find linter configuration file

root GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES

GROOVY_NPM_GROOVY_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling GROOVYNPMGROOVY_LINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root GROOVY_POST_COMMANDS

Post commands for GROOVY descriptor

Type: array

GROOVY: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root GROOVY_POST_COMMANDS Command

Command

Type: object

Command information

root GROOVY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GROOVY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GROOVY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GROOVY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GROOVY_POST_COMMANDS Command output_variables output_variables items
Type: string

root GROOVY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GROOVY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GROOVY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root GROOVY_PRE_COMMANDS

Pre commands for GROOVY descriptor

Type: array

GROOVY: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root GROOVY_PRE_COMMANDS Command

Command

Type: object

Command information

root GROOVY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root GROOVY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root GROOVY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root GROOVY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root GROOVY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root GROOVY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root GROOVY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root GROOVY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_DJLINT_ARGUMENTS

HTML_DJLINT: Custom arguments

Type: array of string or string

HTML_DJLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_ARGUMENTS HTML_DJLINT_ARGUMENTS items
Type: string

root HTML_DJLINT_CLI_EXECUTABLE

HTML_DJLINT: CLI Executable

Type: array of string Default: [["djlint"]]

HTML_DJLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_CLI_EXECUTABLE HTML_DJLINT_CLI_EXECUTABLE items
Type: string

root HTML_DJLINT_CLI_LINT_MODE

HTML_DJLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

HTML_DJLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS

HTML_DJLINT: Custom remove arguments

Type: array of string or string

HTML_DJLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root HTML_DJLINT_DISABLE_ERRORS

HTML_DJLINT: Disable errors

Type: boolean Default: false

HTMLDJLINT: If true, HTMLDJLINT doesn't make MegaLinter fail even if errors are found

root HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN

HTML_DJLINT: Maximum number of errors allowed

Type: number Default: 0

HTMLDJLINT: If the number of errors found is less than this value, HTMLDJLINT doesn't make MegaLinter fail

root HTML_DJLINT_FILE_EXTENSIONS

HTML_DJLINT: Matching files extensions

Type: array of string Default: [".html", ".htm"]

HTML_DJLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_FILE_EXTENSIONS HTML_DJLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root HTML_DJLINT_FILE_NAMES_REGEX

HTML_DJLINT: Matching file name regexes

Type: array of string Default: []

HTML_DJLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_FILE_NAMES_REGEX HTML_DJLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root HTML_DJLINT_FILTER_REGEX_EXCLUDE

HTML_DJLINT: Excluding Regex

Type: string

HTML_DJLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root HTML_DJLINT_FILTER_REGEX_INCLUDE

HTML_DJLINT: Including Regex

Type: string

HTML_DJLINT: Custom regex including filter: only files matching this regex will be linted

root HTML_DJLINT_POST_COMMANDS

HTML_DJLINT: Post-run commands

Type: array

HTMLDJLINT: Define bash commands to run after running HTMLDJLINT

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_POST_COMMANDS Command

Command

Type: object

Command information

root HTML_DJLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_DJLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_DJLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_DJLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root HTML_DJLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_DJLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_DJLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_DJLINT_PRE_COMMANDS

HTML_DJLINT: Pre-run commands

Type: array

HTMLDJLINT: Define bash commands to run before running HTMLDJLINT

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root HTML_DJLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_DJLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_DJLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_DJLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root HTML_DJLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_DJLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_DJLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_DJLINT_UNSECURED_ENV_VARIABLES

HTML_DJLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling HTML_DJLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root HTML_DJLINT_UNSECURED_ENV_VARIABLES HTML_DJLINT_UNSECURED_ENV_VARIABLES items
Type: string

root HTML_FILTER_REGEX_EXCLUDE

Excluding regex filter for HTML descriptor

Type: string

HTML: Custom regex excluding filter: files matching this regex will NOT be linted

root HTML_FILTER_REGEX_INCLUDE

Including regex filter for HTML descriptor

Type: string

HTML: Custom regex including filter: only files matching this regex will be linted

root HTML_HTMLHINT_ARGUMENTS

HTML_HTMLHINT: Custom arguments

Type: array of string or string

HTML_HTMLHINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_ARGUMENTS HTML_HTMLHINT_ARGUMENTS items
Type: string

root HTML_HTMLHINT_CLI_EXECUTABLE

HTML_HTMLHINT: CLI Executable

Type: array of string Default: [["htmlhint"]]

HTML_HTMLHINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_CLI_EXECUTABLE HTML_HTMLHINT_CLI_EXECUTABLE items
Type: string

root HTML_HTMLHINT_CLI_LINT_MODE

HTML_HTMLHINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

HTML_HTMLHINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS

HTML_HTMLHINT: Custom remove arguments

Type: array of string or string

HTML_HTMLHINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root HTML_HTMLHINT_CONFIG_FILE

HTML_HTMLHINT: Custom config file name

Type: string Default: ".htmlhintrc"

HTML_HTMLHINT: User custom config file name if different from default

root HTML_HTMLHINT_DISABLE_ERRORS

HTML_HTMLHINT: Disable errors

Type: boolean Default: false

HTMLHTMLHINT: If true, HTMLHTMLHINT doesn't make MegaLinter fail even if errors are found

root HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN

HTML_HTMLHINT: Maximum number of errors allowed

Type: number Default: 0

HTMLHTMLHINT: If the number of errors found is less than this value, HTMLHTMLHINT doesn't make MegaLinter fail

root HTML_HTMLHINT_FILE_EXTENSIONS

HTML_HTMLHINT: Matching files extensions

Type: array of string Default: [".html", ".htm"]

HTML_HTMLHINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_FILE_EXTENSIONS HTML_HTMLHINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root HTML_HTMLHINT_FILE_NAMES_REGEX

HTML_HTMLHINT: Matching file name regexes

Type: array of string Default: []

HTML_HTMLHINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_FILE_NAMES_REGEX HTML_HTMLHINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root HTML_HTMLHINT_FILTER_REGEX_EXCLUDE

HTML_HTMLHINT: Excluding Regex

Type: string

HTML_HTMLHINT: Custom regex excluding filter: files matching this regex will NOT be linted

root HTML_HTMLHINT_FILTER_REGEX_INCLUDE

HTML_HTMLHINT: Including Regex

Type: string

HTML_HTMLHINT: Custom regex including filter: only files matching this regex will be linted

root HTML_HTMLHINT_POST_COMMANDS

HTML_HTMLHINT: Post-run commands

Type: array

HTMLHTMLHINT: Define bash commands to run after running HTMLHTMLHINT

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_POST_COMMANDS Command

Command

Type: object

Command information

root HTML_HTMLHINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_HTMLHINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_HTMLHINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_HTMLHINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root HTML_HTMLHINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_HTMLHINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_HTMLHINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_HTMLHINT_PRE_COMMANDS

HTML_HTMLHINT: Pre-run commands

Type: array

HTMLHTMLHINT: Define bash commands to run before running HTMLHTMLHINT

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_PRE_COMMANDS Command

Command

Type: object

Command information

root HTML_HTMLHINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_HTMLHINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_HTMLHINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_HTMLHINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root HTML_HTMLHINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_HTMLHINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_HTMLHINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_HTMLHINT_RULES_PATH

HTML_HTMLHINT: Custom config file path

Type: string

HTML_HTMLHINT: Path where to find linter configuration file

root HTML_HTMLHINT_UNSECURED_ENV_VARIABLES

HTML_HTMLHINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling HTML_HTMLHINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root HTML_HTMLHINT_UNSECURED_ENV_VARIABLES HTML_HTMLHINT_UNSECURED_ENV_VARIABLES items
Type: string

root HTML_POST_COMMANDS

Post commands for HTML descriptor

Type: array

HTML: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root HTML_POST_COMMANDS Command

Command

Type: object

Command information

root HTML_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_POST_COMMANDS Command output_variables output_variables items
Type: string

root HTML_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root HTML_PRE_COMMANDS

Pre commands for HTML descriptor

Type: array

HTML: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root HTML_PRE_COMMANDS Command

Command

Type: object

Command information

root HTML_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root HTML_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root HTML_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root HTML_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root HTML_PRE_COMMANDS Command output_variables output_variables items
Type: string

root HTML_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root HTML_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root HTML_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root IGNORE_GENERATED_FILES

Ignore @generated files

Type: boolean Default: false

Makes MegaLinter skip files containing @generated marker (and not containing @not-generated)

root IGNORE_GITIGNORED_FILES

Ignore .gitignored files

Type: boolean Default: false

Makes MegaLinter skip files that are ignored by git using .gitignore

root JAVASCRIPT_DEFAULT_STYLE

Javascript default style

Type: enum (of string) Default: "prettier"

Style of javascript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"

"prettier"

root JAVASCRIPT_ES_ARGUMENTS

JAVASCRIPT_ES: Custom arguments

Type: array of string or string

JAVASCRIPT_ES: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_ARGUMENTS JAVASCRIPT_ES_ARGUMENTS items
Type: string

root JAVASCRIPT_ES_CLI_EXECUTABLE

JAVASCRIPT_ES: CLI Executable

Type: array of string Default: [["eslint"]]

JAVASCRIPT_ES: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_CLI_EXECUTABLE JAVASCRIPT_ES_CLI_EXECUTABLE items
Type: string

root JAVASCRIPT_ES_CLI_LINT_MODE

JAVASCRIPT_ES: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JAVASCRIPT_ES: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS

JAVASCRIPT_ES: Custom remove arguments

Type: array of string or string

JAVASCRIPT_ES: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JAVASCRIPT_ES_CONFIG_FILE

JAVASCRIPT_ES: Custom config file name

Type: string Default: ".eslintrc.json"

JAVASCRIPT_ES: User custom config file name if different from default

root JAVASCRIPT_ES_DISABLE_ERRORS

JAVASCRIPT_ES: Disable errors

Type: boolean Default: false

JAVASCRIPTES: If true, JAVASCRIPTES doesn't make MegaLinter fail even if errors are found

root JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN

JAVASCRIPT_ES: Maximum number of errors allowed

Type: number Default: 0

JAVASCRIPTES: If the number of errors found is less than this value, JAVASCRIPTES doesn't make MegaLinter fail

root JAVASCRIPT_ES_FILE_EXTENSIONS

JAVASCRIPT_ES: Matching files extensions

Type: array of string Default: [".js", ".vue"]

JAVASCRIPT_ES: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_FILE_EXTENSIONS JAVASCRIPT_ES_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JAVASCRIPT_ES_FILE_NAMES_REGEX

JAVASCRIPT_ES: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_ES: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_FILE_NAMES_REGEX JAVASCRIPT_ES_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE

JAVASCRIPT_ES: Excluding Regex

Type: string

JAVASCRIPT_ES: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVASCRIPT_ES_FILTER_REGEX_INCLUDE

JAVASCRIPT_ES: Including Regex

Type: string

JAVASCRIPT_ES: Custom regex including filter: only files matching this regex will be linted

root JAVASCRIPT_ES_POST_COMMANDS

JAVASCRIPT_ES: Post-run commands

Type: array

JAVASCRIPTES: Define bash commands to run after running JAVASCRIPTES

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_POST_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_ES_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_ES_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_ES_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_ES_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_ES_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_ES_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_ES_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_ES_PRE_COMMANDS

JAVASCRIPT_ES: Pre-run commands

Type: array

JAVASCRIPTES: Define bash commands to run before running JAVASCRIPTES

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_ES_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_ES_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_ES_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_ES_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_ES_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_ES_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_ES_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_ES_RULES_PATH

JAVASCRIPT_ES: Custom config file path

Type: string

JAVASCRIPT_ES: Path where to find linter configuration file

root JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES

JAVASCRIPT_ES: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JAVASCRIPT_ES and its pre/post commands

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES items
Type: string

root JAVASCRIPT_FILTER_REGEX_EXCLUDE

Excluding regex filter for JAVASCRIPT descriptor

Type: string

JAVASCRIPT: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVASCRIPT_FILTER_REGEX_INCLUDE

Including regex filter for JAVASCRIPT descriptor

Type: string

JAVASCRIPT: Custom regex including filter: only files matching this regex will be linted

root JAVASCRIPT_POST_COMMANDS

Post commands for JAVASCRIPT descriptor

Type: array

JAVASCRIPT: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_POST_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_PRETTIER_ARGUMENTS

JAVASCRIPT_PRETTIER: Custom arguments

Type: array of string or string

JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_ARGUMENTS JAVASCRIPT_PRETTIER_ARGUMENTS items
Type: string

root JAVASCRIPT_PRETTIER_CLI_EXECUTABLE

JAVASCRIPT_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

JAVASCRIPT_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_CLI_EXECUTABLE JAVASCRIPT_PRETTIER_CLI_EXECUTABLE items
Type: string

root JAVASCRIPT_PRETTIER_CLI_LINT_MODE

JAVASCRIPT_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JAVASCRIPT_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS

JAVASCRIPT_PRETTIER: Custom remove arguments

Type: array of string or string

JAVASCRIPT_PRETTIER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JAVASCRIPT_PRETTIER_CONFIG_FILE

JAVASCRIPT_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

JAVASCRIPT_PRETTIER: User custom config file name if different from default

root JAVASCRIPT_PRETTIER_DISABLE_ERRORS

JAVASCRIPT_PRETTIER: Disable errors

Type: boolean Default: false

JAVASCRIPTPRETTIER: If true, JAVASCRIPTPRETTIER doesn't make MegaLinter fail even if errors are found

root JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN

JAVASCRIPT_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

JAVASCRIPTPRETTIER: If the number of errors found is less than this value, JAVASCRIPTPRETTIER doesn't make MegaLinter fail

root JAVASCRIPT_PRETTIER_FILE_EXTENSIONS

JAVASCRIPT_PRETTIER: Matching files extensions

Type: array of string Default: [".js"]

JAVASCRIPT_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_FILE_EXTENSIONS JAVASCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX

JAVASCRIPT_PRETTIER: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE

JAVASCRIPT_PRETTIER: Excluding Regex

Type: string

JAVASCRIPT_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE

JAVASCRIPT_PRETTIER: Including Regex

Type: string

JAVASCRIPT_PRETTIER: Custom regex including filter: only files matching this regex will be linted

root JAVASCRIPT_PRETTIER_POST_COMMANDS

JAVASCRIPT_PRETTIER: Post-run commands

Type: array

JAVASCRIPTPRETTIER: Define bash commands to run after running JAVASCRIPTPRETTIER

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_PRETTIER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_PRETTIER_PRE_COMMANDS

JAVASCRIPT_PRETTIER: Pre-run commands

Type: array

JAVASCRIPTPRETTIER: Define bash commands to run before running JAVASCRIPTPRETTIER

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_PRETTIER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_PRETTIER_RULES_PATH

JAVASCRIPT_PRETTIER: Custom config file path

Type: string

JAVASCRIPT_PRETTIER: Path where to find linter configuration file

root JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES

JAVASCRIPT_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JAVASCRIPT_PRETTIER and its pre/post commands

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES items
Type: string

root JAVASCRIPT_PRE_COMMANDS

Pre commands for JAVASCRIPT descriptor

Type: array

JAVASCRIPT: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_STANDARD_ARGUMENTS

JAVASCRIPT_STANDARD: Custom arguments

Type: array of string or string

JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_ARGUMENTS JAVASCRIPT_STANDARD_ARGUMENTS items
Type: string

root JAVASCRIPT_STANDARD_CLI_EXECUTABLE

JAVASCRIPT_STANDARD: CLI Executable

Type: array of string Default: [["standard"]]

JAVASCRIPT_STANDARD: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_CLI_EXECUTABLE JAVASCRIPT_STANDARD_CLI_EXECUTABLE items
Type: string

root JAVASCRIPT_STANDARD_CLI_LINT_MODE

JAVASCRIPT_STANDARD: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JAVASCRIPT_STANDARD: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS

JAVASCRIPT_STANDARD: Custom remove arguments

Type: array of string or string

JAVASCRIPT_STANDARD: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JAVASCRIPT_STANDARD_DISABLE_ERRORS

JAVASCRIPT_STANDARD: Disable errors

Type: boolean Default: false

JAVASCRIPTSTANDARD: If true, JAVASCRIPTSTANDARD doesn't make MegaLinter fail even if errors are found

root JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN

JAVASCRIPT_STANDARD: Maximum number of errors allowed

Type: number Default: 0

JAVASCRIPTSTANDARD: If the number of errors found is less than this value, JAVASCRIPTSTANDARD doesn't make MegaLinter fail

root JAVASCRIPT_STANDARD_FILE_EXTENSIONS

JAVASCRIPT_STANDARD: Matching files extensions

Type: array of string Default: [".js"]

JAVASCRIPT_STANDARD: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_FILE_EXTENSIONS JAVASCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JAVASCRIPT_STANDARD_FILE_NAMES_REGEX

JAVASCRIPT_STANDARD: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_STANDARD: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_FILE_NAMES_REGEX JAVASCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE

JAVASCRIPT_STANDARD: Excluding Regex

Type: string

JAVASCRIPT_STANDARD: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE

JAVASCRIPT_STANDARD: Including Regex

Type: string

JAVASCRIPT_STANDARD: Custom regex including filter: only files matching this regex will be linted

root JAVASCRIPT_STANDARD_POST_COMMANDS

JAVASCRIPT_STANDARD: Post-run commands

Type: array

JAVASCRIPTSTANDARD: Define bash commands to run after running JAVASCRIPTSTANDARD

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_POST_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_STANDARD_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_STANDARD_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_STANDARD_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_STANDARD_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_STANDARD_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_STANDARD_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_STANDARD_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_STANDARD_PRE_COMMANDS

JAVASCRIPT_STANDARD: Pre-run commands

Type: array

JAVASCRIPTSTANDARD: Define bash commands to run before running JAVASCRIPTSTANDARD

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVASCRIPT_STANDARD_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES

JAVASCRIPT_STANDARD: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JAVASCRIPT_STANDARD and its pre/post commands

 No Additional Items

Each item of this array must be:

root JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES items
Type: string

root JAVA_CHECKSTYLE_ARGUMENTS

JAVA_CHECKSTYLE: Custom arguments

Type: array of string or string

JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_ARGUMENTS JAVA_CHECKSTYLE_ARGUMENTS items
Type: string

root JAVA_CHECKSTYLE_CLI_EXECUTABLE

JAVA_CHECKSTYLE: CLI Executable

Type: array of string Default: [["java"]]

JAVA_CHECKSTYLE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_CLI_EXECUTABLE JAVA_CHECKSTYLE_CLI_EXECUTABLE items
Type: string

root JAVA_CHECKSTYLE_CLI_LINT_MODE

JAVA_CHECKSTYLE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JAVA_CHECKSTYLE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS

JAVA_CHECKSTYLE: Custom remove arguments

Type: array of string or string

JAVA_CHECKSTYLE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JAVA_CHECKSTYLE_CONFIG_FILE

JAVA_CHECKSTYLE: Custom config file name

Type: string Default: "sun_checks.xml"

JAVA_CHECKSTYLE: User custom config file name if different from default

root JAVA_CHECKSTYLE_DISABLE_ERRORS

JAVA_CHECKSTYLE: Disable errors

Type: boolean Default: false

JAVACHECKSTYLE: If true, JAVACHECKSTYLE doesn't make MegaLinter fail even if errors are found

root JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN

JAVA_CHECKSTYLE: Maximum number of errors allowed

Type: number Default: 0

JAVACHECKSTYLE: If the number of errors found is less than this value, JAVACHECKSTYLE doesn't make MegaLinter fail

root JAVA_CHECKSTYLE_FILE_EXTENSIONS

JAVA_CHECKSTYLE: Matching files extensions

Type: array of string Default: [".java"]

JAVA_CHECKSTYLE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_FILE_EXTENSIONS JAVA_CHECKSTYLE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JAVA_CHECKSTYLE_FILE_NAMES_REGEX

JAVA_CHECKSTYLE: Matching file name regexes

Type: array of string Default: []

JAVA_CHECKSTYLE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_FILE_NAMES_REGEX JAVA_CHECKSTYLE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE

JAVA_CHECKSTYLE: Excluding Regex

Type: string

JAVA_CHECKSTYLE: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE

JAVA_CHECKSTYLE: Including Regex

Type: string

JAVA_CHECKSTYLE: Custom regex including filter: only files matching this regex will be linted

root JAVA_CHECKSTYLE_POST_COMMANDS

JAVA_CHECKSTYLE: Post-run commands

Type: array

JAVACHECKSTYLE: Define bash commands to run after running JAVACHECKSTYLE

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_POST_COMMANDS Command

Command

Type: object

Command information

root JAVA_CHECKSTYLE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_CHECKSTYLE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_CHECKSTYLE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_CHECKSTYLE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_CHECKSTYLE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_CHECKSTYLE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_CHECKSTYLE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVA_CHECKSTYLE_PRE_COMMANDS

JAVA_CHECKSTYLE: Pre-run commands

Type: array

JAVACHECKSTYLE: Define bash commands to run before running JAVACHECKSTYLE

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVA_CHECKSTYLE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_CHECKSTYLE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_CHECKSTYLE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_CHECKSTYLE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_CHECKSTYLE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_CHECKSTYLE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_CHECKSTYLE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVA_CHECKSTYLE_RULES_PATH

JAVA_CHECKSTYLE: Custom config file path

Type: string

JAVA_CHECKSTYLE: Path where to find linter configuration file

root JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES

JAVA_CHECKSTYLE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JAVA_CHECKSTYLE and its pre/post commands

 No Additional Items

Each item of this array must be:

root JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES items
Type: string

root JAVA_FILTER_REGEX_EXCLUDE

Excluding regex filter for JAVA descriptor

Type: string

JAVA: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVA_FILTER_REGEX_INCLUDE

Including regex filter for JAVA descriptor

Type: string

JAVA: Custom regex including filter: only files matching this regex will be linted

root JAVA_PMD_ARGUMENTS

JAVA_PMD: Custom arguments

Type: array of string or string

JAVA_PMD: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JAVA_PMD_ARGUMENTS JAVA_PMD_ARGUMENTS items
Type: string

root JAVA_PMD_CLI_EXECUTABLE

JAVA_PMD: CLI Executable

Type: array of string Default: [["/usr/bin/pmd/bin/pmd"]]

JAVA_PMD: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JAVA_PMD_CLI_EXECUTABLE JAVA_PMD_CLI_EXECUTABLE items
Type: string

root JAVA_PMD_CLI_LINT_MODE

JAVA_PMD: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JAVA_PMD: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JAVA_PMD_COMMAND_REMOVE_ARGUMENTS

JAVA_PMD: Custom remove arguments

Type: array of string or string

JAVA_PMD: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JAVA_PMD_COMMAND_REMOVE_ARGUMENTS JAVA_PMD_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JAVA_PMD_CONFIG_FILE

JAVA_PMD: Custom config file name

Type: string Default: "java-pmd-ruleset.xml"

JAVA_PMD: User custom config file name if different from default

root JAVA_PMD_DISABLE_ERRORS

JAVA_PMD: Disable errors

Type: boolean Default: false

JAVAPMD: If true, JAVAPMD doesn't make MegaLinter fail even if errors are found

root JAVA_PMD_DISABLE_ERRORS_IF_LESS_THAN

JAVA_PMD: Maximum number of errors allowed

Type: number Default: 0

JAVAPMD: If the number of errors found is less than this value, JAVAPMD doesn't make MegaLinter fail

root JAVA_PMD_FILE_EXTENSIONS

JAVA_PMD: Matching files extensions

Type: array of string Default: [".java"]

JAVA_PMD: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVA_PMD_FILE_EXTENSIONS JAVA_PMD_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JAVA_PMD_FILE_NAMES_REGEX

JAVA_PMD: Matching file name regexes

Type: array of string Default: []

JAVA_PMD: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JAVA_PMD_FILE_NAMES_REGEX JAVA_PMD_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JAVA_PMD_FILTER_REGEX_EXCLUDE

JAVA_PMD: Excluding Regex

Type: string

JAVA_PMD: Custom regex excluding filter: files matching this regex will NOT be linted

root JAVA_PMD_FILTER_REGEX_INCLUDE

JAVA_PMD: Including Regex

Type: string

JAVA_PMD: Custom regex including filter: only files matching this regex will be linted

root JAVA_PMD_POST_COMMANDS

JAVA_PMD: Post-run commands

Type: array

JAVAPMD: Define bash commands to run after running JAVAPMD

 No Additional Items

Each item of this array must be:

root JAVA_PMD_POST_COMMANDS Command

Command

Type: object

Command information

root JAVA_PMD_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_PMD_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_PMD_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_PMD_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_PMD_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_PMD_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_PMD_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_PMD_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVA_PMD_PRE_COMMANDS

JAVA_PMD: Pre-run commands

Type: array

JAVAPMD: Define bash commands to run before running JAVAPMD

 No Additional Items

Each item of this array must be:

root JAVA_PMD_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVA_PMD_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_PMD_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_PMD_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_PMD_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_PMD_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_PMD_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_PMD_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_PMD_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVA_PMD_RULES_PATH

JAVA_PMD: Custom config file path

Type: string

JAVA_PMD: Path where to find linter configuration file

root JAVA_PMD_UNSECURED_ENV_VARIABLES

JAVA_PMD: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JAVA_PMD and its pre/post commands

 No Additional Items

Each item of this array must be:

root JAVA_PMD_UNSECURED_ENV_VARIABLES JAVA_PMD_UNSECURED_ENV_VARIABLES items
Type: string

root JAVA_POST_COMMANDS

Post commands for JAVA descriptor

Type: array

JAVA: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root JAVA_POST_COMMANDS Command

Command

Type: object

Command information

root JAVA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_POST_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JAVA_PRE_COMMANDS

Pre commands for JAVA descriptor

Type: array

JAVA: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root JAVA_PRE_COMMANDS Command

Command

Type: object

Command information

root JAVA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JAVA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JAVA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JAVA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JAVA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JAVA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JAVA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JAVA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JOB_SUMMARY_ADDITIONAL_MARKDOWN

Job Summary additional markdown

Type: string

Custom markdown to add at the end of the summary message posted on a PR/MR

root JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS

JSON_ESLINT_PLUGIN_JSONC: Custom arguments

Type: array of string or string

JSONESLINTPLUGIN_JSONC: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE

JSON_ESLINT_PLUGIN_JSONC: CLI Executable

Type: array of string Default: [["eslint"]]

JSONESLINTPLUGIN_JSONC: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE

JSON_ESLINT_PLUGIN_JSONC: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JSONESLINTPLUGIN_JSONC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS

JSON_ESLINT_PLUGIN_JSONC: Custom remove arguments

Type: array of string or string

JSONESLINTPLUGIN_JSONC: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE

JSON_ESLINT_PLUGIN_JSONC: Custom config file name

Type: string Default: ".eslintrc-json.json"

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

root JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS

JSON_ESLINT_PLUGIN_JSONC: Disable errors

Type: boolean Default: false

JSONESLINTPLUGINJSONC: If true, JSONESLINTPLUGINJSONC doesn't make MegaLinter fail even if errors are found

root JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN

JSON_ESLINT_PLUGIN_JSONC: Maximum number of errors allowed

Type: number Default: 0

JSONESLINTPLUGINJSONC: If the number of errors found is less than this value, JSONESLINTPLUGINJSONC doesn't make MegaLinter fail

root JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS

JSON_ESLINT_PLUGIN_JSONC: Matching files extensions

Type: array of string Default: [".json", ".json5", ".jsonc"]

JSONESLINTPLUGIN_JSONC: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX

JSON_ESLINT_PLUGIN_JSONC: Matching file name regexes

Type: array of string Default: []

JSONESLINTPLUGIN_JSONC: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE

JSON_ESLINT_PLUGIN_JSONC: Excluding Regex

Type: string

JSONESLINTPLUGIN_JSONC: Custom regex excluding filter: files matching this regex will NOT be linted

root JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE

JSON_ESLINT_PLUGIN_JSONC: Including Regex

Type: string

JSONESLINTPLUGIN_JSONC: Custom regex including filter: only files matching this regex will be linted

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS

JSON_ESLINT_PLUGIN_JSONC: Post-run commands

Type: array

JSONESLINTPLUGINJSONC: Define bash commands to run after running JSONESLINTPLUGINJSONC

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS

JSON_ESLINT_PLUGIN_JSONC: Pre-run commands

Type: array

JSONESLINTPLUGINJSONC: Define bash commands to run before running JSONESLINTPLUGINJSONC

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_ESLINT_PLUGIN_JSONC_RULES_PATH

JSON_ESLINT_PLUGIN_JSONC: Custom config file path

Type: string

JSONESLINTPLUGIN_JSONC: Path where to find linter configuration file

root JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES

JSON_ESLINT_PLUGIN_JSONC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSONESLINTPLUGIN_JSONC and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES items
Type: string

root JSON_FILTER_REGEX_EXCLUDE

Excluding regex filter for JSON descriptor

Type: string

JSON: Custom regex excluding filter: files matching this regex will NOT be linted

root JSON_FILTER_REGEX_INCLUDE

Including regex filter for JSON descriptor

Type: string

JSON: Custom regex including filter: only files matching this regex will be linted

root JSON_JSONLINT_ARGUMENTS

JSON_JSONLINT: Custom arguments

Type: array of string or string

JSON_JSONLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_ARGUMENTS JSON_JSONLINT_ARGUMENTS items
Type: string

root JSON_JSONLINT_CLI_EXECUTABLE

JSON_JSONLINT: CLI Executable

Type: array of string Default: [["jsonlint"]]

JSON_JSONLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_CLI_EXECUTABLE JSON_JSONLINT_CLI_EXECUTABLE items
Type: string

root JSON_JSONLINT_CLI_LINT_MODE

JSON_JSONLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JSON_JSONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS

JSON_JSONLINT: Custom remove arguments

Type: array of string or string

JSON_JSONLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSON_JSONLINT_CONFIG_FILE

JSON_JSONLINT: Custom config file name

Type: string Default: ".jsonlintrc"

JSON_JSONLINT: User custom config file name if different from default

root JSON_JSONLINT_DISABLE_ERRORS

JSON_JSONLINT: Disable errors

Type: boolean Default: false

JSONJSONLINT: If true, JSONJSONLINT doesn't make MegaLinter fail even if errors are found

root JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN

JSON_JSONLINT: Maximum number of errors allowed

Type: number Default: 0

JSONJSONLINT: If the number of errors found is less than this value, JSONJSONLINT doesn't make MegaLinter fail

root JSON_JSONLINT_FILE_EXTENSIONS

JSON_JSONLINT: Matching files extensions

Type: array of string Default: [".json"]

JSON_JSONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_FILE_EXTENSIONS JSON_JSONLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSON_JSONLINT_FILE_NAMES_REGEX

JSON_JSONLINT: Matching file name regexes

Type: array of string Default: []

JSON_JSONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_FILE_NAMES_REGEX JSON_JSONLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSON_JSONLINT_FILTER_REGEX_EXCLUDE

JSON_JSONLINT: Excluding Regex

Type: string

JSON_JSONLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root JSON_JSONLINT_FILTER_REGEX_INCLUDE

JSON_JSONLINT: Including Regex

Type: string

JSON_JSONLINT: Custom regex including filter: only files matching this regex will be linted

root JSON_JSONLINT_POST_COMMANDS

JSON_JSONLINT: Post-run commands

Type: array

JSONJSONLINT: Define bash commands to run after running JSONJSONLINT

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_JSONLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_JSONLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_JSONLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_JSONLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_JSONLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_JSONLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_JSONLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_JSONLINT_PRE_COMMANDS

JSON_JSONLINT: Pre-run commands

Type: array

JSONJSONLINT: Define bash commands to run before running JSONJSONLINT

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_JSONLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_JSONLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_JSONLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_JSONLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_JSONLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_JSONLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_JSONLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_JSONLINT_RULES_PATH

JSON_JSONLINT: Custom config file path

Type: string

JSON_JSONLINT: Path where to find linter configuration file

root JSON_JSONLINT_UNSECURED_ENV_VARIABLES

JSON_JSONLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSON_JSONLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSON_JSONLINT_UNSECURED_ENV_VARIABLES JSON_JSONLINT_UNSECURED_ENV_VARIABLES items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS

JSON_NPM_PACKAGE_JSON_LINT: Custom arguments

Type: array of string or string

JSONNPMPACKAGEJSONLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE

JSON_NPM_PACKAGE_JSON_LINT: CLI Executable

Type: array of string Default: [["npmPkgJsonLint"]]

JSONNPMPACKAGEJSONLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_CLI_LINT_MODE

JSON_NPM_PACKAGE_JSON_LINT: CLI lint mode

Type: enum (of string) Default: "project"

JSONNPMPACKAGEJSONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS

JSON_NPM_PACKAGE_JSON_LINT: Custom remove arguments

Type: array of string or string

JSONNPMPACKAGEJSONLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_CONFIG_FILE

JSON_NPM_PACKAGE_JSON_LINT: Custom config file name

Type: string Default: ".npmpackagejsonlintrc.json"

JSONNPMPACKAGEJSONLINT: User custom config file name if different from default

root JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS

JSON_NPM_PACKAGE_JSON_LINT: Disable errors

Type: boolean Default: false

JSONNPMPACKAGEJSONLINT: If true, JSONNPMPACKAGEJSONLINT doesn't make MegaLinter fail even if errors are found

root JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS_IF_LESS_THAN

JSON_NPM_PACKAGE_JSON_LINT: Maximum number of errors allowed

Type: number Default: 0

JSONNPMPACKAGEJSONLINT: If the number of errors found is less than this value, JSONNPMPACKAGEJSONLINT doesn't make MegaLinter fail

root JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS

JSON_NPM_PACKAGE_JSON_LINT: Matching files extensions

Type: array of string Default: [".json"]

JSONNPMPACKAGEJSONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX

JSON_NPM_PACKAGE_JSON_LINT: Matching file name regexes

Type: array of string Default: ["package\\.json"]

JSONNPMPACKAGEJSONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS

JSON_NPM_PACKAGE_JSON_LINT: Post-run commands

Type: array

JSONNPMPACKAGEJSONLINT: Define bash commands to run after running JSONNPMPACKAGEJSONLINT

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS

JSON_NPM_PACKAGE_JSON_LINT: Pre-run commands

Type: array

JSONNPMPACKAGEJSONLINT: Define bash commands to run before running JSONNPMPACKAGEJSONLINT

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_NPM_PACKAGE_JSON_LINT_RULES_PATH

JSON_NPM_PACKAGE_JSON_LINT: Custom config file path

Type: string

JSONNPMPACKAGEJSONLINT: Path where to find linter configuration file

root JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES

JSON_NPM_PACKAGE_JSON_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSONNPMPACKAGEJSONLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root JSON_POST_COMMANDS

Post commands for JSON descriptor

Type: array

JSON: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root JSON_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_PRETTIER_ARGUMENTS

JSON_PRETTIER: Custom arguments

Type: array of string or string

JSON_PRETTIER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_ARGUMENTS JSON_PRETTIER_ARGUMENTS items
Type: string

root JSON_PRETTIER_CLI_EXECUTABLE

JSON_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

JSON_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_CLI_EXECUTABLE JSON_PRETTIER_CLI_EXECUTABLE items
Type: string

root JSON_PRETTIER_CLI_LINT_MODE

JSON_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JSON_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS

JSON_PRETTIER: Custom remove arguments

Type: array of string or string

JSON_PRETTIER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSON_PRETTIER_CONFIG_FILE

JSON_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

JSON_PRETTIER: User custom config file name if different from default

root JSON_PRETTIER_DISABLE_ERRORS

JSON_PRETTIER: Disable errors

Type: boolean Default: false

JSONPRETTIER: If true, JSONPRETTIER doesn't make MegaLinter fail even if errors are found

root JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN

JSON_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

JSONPRETTIER: If the number of errors found is less than this value, JSONPRETTIER doesn't make MegaLinter fail

root JSON_PRETTIER_FILE_EXTENSIONS

JSON_PRETTIER: Matching files extensions

Type: array of string Default: [".json"]

JSON_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_FILE_EXTENSIONS JSON_PRETTIER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSON_PRETTIER_FILE_NAMES_REGEX

JSON_PRETTIER: Matching file name regexes

Type: array of string Default: []

JSON_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_FILE_NAMES_REGEX JSON_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSON_PRETTIER_FILTER_REGEX_EXCLUDE

JSON_PRETTIER: Excluding Regex

Type: string

JSON_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

root JSON_PRETTIER_FILTER_REGEX_INCLUDE

JSON_PRETTIER: Including Regex

Type: string

JSON_PRETTIER: Custom regex including filter: only files matching this regex will be linted

root JSON_PRETTIER_POST_COMMANDS

JSON_PRETTIER: Post-run commands

Type: array

JSONPRETTIER: Define bash commands to run after running JSONPRETTIER

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_PRETTIER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_PRETTIER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_PRETTIER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_PRETTIER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_PRETTIER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_PRETTIER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_PRETTIER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_PRETTIER_PRE_COMMANDS

JSON_PRETTIER: Pre-run commands

Type: array

JSONPRETTIER: Define bash commands to run before running JSONPRETTIER

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_PRETTIER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_PRETTIER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_PRETTIER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_PRETTIER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_PRETTIER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_PRETTIER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_PRETTIER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_PRETTIER_RULES_PATH

JSON_PRETTIER: Custom config file path

Type: string

JSON_PRETTIER: Path where to find linter configuration file

root JSON_PRETTIER_UNSECURED_ENV_VARIABLES

JSON_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSON_PRETTIER and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSON_PRETTIER_UNSECURED_ENV_VARIABLES JSON_PRETTIER_UNSECURED_ENV_VARIABLES items
Type: string

root JSON_PRE_COMMANDS

Pre commands for JSON descriptor

Type: array

JSON: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root JSON_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_REPORTER

JSON reporter

Type: boolean Default: false

Output a large execution log in a JSON file named mega-linter-report.json

root JSON_REPORTER_OUTPUT_DETAIL

JSON reporter output detail

Type: enum (of string) Default: "simple"

Defines if output contain only error files (simple) or all files (detailed)

Must be one of:

  • "simple"
  • "detailed"

root JSON_V8R_ARGUMENTS

JSON_V8R: Custom arguments

Type: array of string or string

JSON_V8R: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSON_V8R_ARGUMENTS JSON_V8R_ARGUMENTS items
Type: string

root JSON_V8R_CLI_EXECUTABLE

JSON_V8R: CLI Executable

Type: array of string Default: [["v8r"]]

JSON_V8R: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSON_V8R_CLI_EXECUTABLE JSON_V8R_CLI_EXECUTABLE items
Type: string

root JSON_V8R_CLI_LINT_MODE

JSON_V8R: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JSON_V8R: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSON_V8R_COMMAND_REMOVE_ARGUMENTS

JSON_V8R: Custom remove arguments

Type: array of string or string

JSON_V8R: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSON_V8R_COMMAND_REMOVE_ARGUMENTS JSON_V8R_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSON_V8R_DISABLE_ERRORS

JSON_V8R: Disable errors

Type: boolean Default: false

JSONV8R: If true, JSONV8R doesn't make MegaLinter fail even if errors are found

root JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN

JSON_V8R: Maximum number of errors allowed

Type: number Default: 0

JSONV8R: If the number of errors found is less than this value, JSONV8R doesn't make MegaLinter fail

root JSON_V8R_FILE_EXTENSIONS

JSON_V8R: Matching files extensions

Type: array of string Default: [".json"]

JSON_V8R: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_V8R_FILE_EXTENSIONS JSON_V8R_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSON_V8R_FILE_NAMES_REGEX

JSON_V8R: Matching file name regexes

Type: array of string Default: []

JSON_V8R: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSON_V8R_FILE_NAMES_REGEX JSON_V8R_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSON_V8R_FILTER_REGEX_EXCLUDE

JSON_V8R: Excluding Regex

Type: string

JSON_V8R: Custom regex excluding filter: files matching this regex will NOT be linted

root JSON_V8R_FILTER_REGEX_INCLUDE

JSON_V8R: Including Regex

Type: string

JSON_V8R: Custom regex including filter: only files matching this regex will be linted

root JSON_V8R_POST_COMMANDS

JSON_V8R: Post-run commands

Type: array

JSONV8R: Define bash commands to run after running JSONV8R

 No Additional Items

Each item of this array must be:

root JSON_V8R_POST_COMMANDS Command

Command

Type: object

Command information

root JSON_V8R_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_V8R_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_V8R_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_V8R_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_V8R_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSON_V8R_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_V8R_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_V8R_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_V8R_PRE_COMMANDS

JSON_V8R: Pre-run commands

Type: array

JSONV8R: Define bash commands to run before running JSONV8R

 No Additional Items

Each item of this array must be:

root JSON_V8R_PRE_COMMANDS Command

Command

Type: object

Command information

root JSON_V8R_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSON_V8R_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSON_V8R_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSON_V8R_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSON_V8R_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSON_V8R_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSON_V8R_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSON_V8R_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSON_V8R_UNSECURED_ENV_VARIABLES

JSON_V8R: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSON_V8R and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSON_V8R_UNSECURED_ENV_VARIABLES JSON_V8R_UNSECURED_ENV_VARIABLES items
Type: string

root JSX_ESLINT_ARGUMENTS

JSX_ESLINT: Custom arguments

Type: array of string or string

JSX_ESLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_ARGUMENTS JSX_ESLINT_ARGUMENTS items
Type: string

root JSX_ESLINT_CLI_EXECUTABLE

JSX_ESLINT: CLI Executable

Type: array of string Default: [["eslint"]]

JSX_ESLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_CLI_EXECUTABLE JSX_ESLINT_CLI_EXECUTABLE items
Type: string

root JSX_ESLINT_CLI_LINT_MODE

JSX_ESLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

JSX_ESLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS

JSX_ESLINT: Custom remove arguments

Type: array of string or string

JSX_ESLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root JSX_ESLINT_CONFIG_FILE

JSX_ESLINT: Custom config file name

Type: string Default: "eslint.config.js"

JSX_ESLINT: User custom config file name if different from default

root JSX_ESLINT_DISABLE_ERRORS

JSX_ESLINT: Disable errors

Type: boolean Default: false

JSXESLINT: If true, JSXESLINT doesn't make MegaLinter fail even if errors are found

root JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN

JSX_ESLINT: Maximum number of errors allowed

Type: number Default: 0

JSXESLINT: If the number of errors found is less than this value, JSXESLINT doesn't make MegaLinter fail

root JSX_ESLINT_FILE_EXTENSIONS

JSX_ESLINT: Matching files extensions

Type: array of string Default: [".jsx"]

JSX_ESLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_FILE_EXTENSIONS JSX_ESLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root JSX_ESLINT_FILE_NAMES_REGEX

JSX_ESLINT: Matching file name regexes

Type: array of string Default: []

JSX_ESLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_FILE_NAMES_REGEX JSX_ESLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root JSX_ESLINT_FILTER_REGEX_EXCLUDE

JSX_ESLINT: Excluding Regex

Type: string

JSX_ESLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root JSX_ESLINT_FILTER_REGEX_INCLUDE

JSX_ESLINT: Including Regex

Type: string

JSX_ESLINT: Custom regex including filter: only files matching this regex will be linted

root JSX_ESLINT_POST_COMMANDS

JSX_ESLINT: Post-run commands

Type: array

JSXESLINT: Define bash commands to run after running JSXESLINT

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_POST_COMMANDS Command

Command

Type: object

Command information

root JSX_ESLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSX_ESLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSX_ESLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSX_ESLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSX_ESLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSX_ESLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSX_ESLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSX_ESLINT_PRE_COMMANDS

JSX_ESLINT: Pre-run commands

Type: array

JSXESLINT: Define bash commands to run before running JSXESLINT

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root JSX_ESLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSX_ESLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSX_ESLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSX_ESLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSX_ESLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSX_ESLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSX_ESLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSX_ESLINT_RULES_PATH

JSX_ESLINT: Custom config file path

Type: string

JSX_ESLINT: Path where to find linter configuration file

root JSX_ESLINT_UNSECURED_ENV_VARIABLES

JSX_ESLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling JSX_ESLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root JSX_ESLINT_UNSECURED_ENV_VARIABLES JSX_ESLINT_UNSECURED_ENV_VARIABLES items
Type: string

root JSX_FILTER_REGEX_EXCLUDE

Excluding regex filter for JSX descriptor

Type: string

JSX: Custom regex excluding filter: files matching this regex will NOT be linted

root JSX_FILTER_REGEX_INCLUDE

Including regex filter for JSX descriptor

Type: string

JSX: Custom regex including filter: only files matching this regex will be linted

root JSX_POST_COMMANDS

Post commands for JSX descriptor

Type: array

JSX: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root JSX_POST_COMMANDS Command

Command

Type: object

Command information

root JSX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSX_POST_COMMANDS Command output_variables output_variables items
Type: string

root JSX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root JSX_PRE_COMMANDS

Pre commands for JSX descriptor

Type: array

JSX: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root JSX_PRE_COMMANDS Command

Command

Type: object

Command information

root JSX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root JSX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root JSX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root JSX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root JSX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root JSX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root JSX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root JSX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_DETEKT_ARGUMENTS

KOTLIN_DETEKT: Custom arguments

Type: array of string or string

KOTLIN_DETEKT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_ARGUMENTS KOTLIN_DETEKT_ARGUMENTS items
Type: string

root KOTLIN_DETEKT_CLI_EXECUTABLE

KOTLIN_DETEKT: CLI Executable

Type: array of string Default: [["detekt-cli"]]

KOTLIN_DETEKT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_CLI_EXECUTABLE KOTLIN_DETEKT_CLI_EXECUTABLE items
Type: string

root KOTLIN_DETEKT_CLI_LINT_MODE

KOTLIN_DETEKT: CLI lint mode

Type: enum (of string) Default: "project"

KOTLIN_DETEKT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root KOTLIN_DETEKT_COMMAND_REMOVE_ARGUMENTS

KOTLIN_DETEKT: Custom remove arguments

Type: array of string or string

KOTLIN_DETEKT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_COMMAND_REMOVE_ARGUMENTS KOTLIN_DETEKT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root KOTLIN_DETEKT_CONFIG_FILE

KOTLIN_DETEKT: Custom config file name

Type: string Default: "detekt-config.yml"

KOTLIN_DETEKT: User custom config file name if different from default

root KOTLIN_DETEKT_DISABLE_ERRORS

KOTLIN_DETEKT: Disable errors

Type: boolean Default: false

KOTLINDETEKT: If true, KOTLINDETEKT doesn't make MegaLinter fail even if errors are found

root KOTLIN_DETEKT_DISABLE_ERRORS_IF_LESS_THAN

KOTLIN_DETEKT: Maximum number of errors allowed

Type: number Default: 0

KOTLINDETEKT: If the number of errors found is less than this value, KOTLINDETEKT doesn't make MegaLinter fail

root KOTLIN_DETEKT_FILE_EXTENSIONS

KOTLIN_DETEKT: Matching files extensions

Type: array of string Default: [".kt", ".kts"]

KOTLIN_DETEKT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_FILE_EXTENSIONS KOTLIN_DETEKT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root KOTLIN_DETEKT_FILE_NAMES_REGEX

KOTLIN_DETEKT: Matching file name regexes

Type: array of string Default: []

KOTLIN_DETEKT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_FILE_NAMES_REGEX KOTLIN_DETEKT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KOTLIN_DETEKT_POST_COMMANDS

KOTLIN_DETEKT: Post-run commands

Type: array

KOTLINDETEKT: Define bash commands to run after running KOTLINDETEKT

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_POST_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_DETEKT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_DETEKT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_DETEKT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_DETEKT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_POST_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_DETEKT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_DETEKT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_DETEKT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_DETEKT_PRE_COMMANDS

KOTLIN_DETEKT: Pre-run commands

Type: array

KOTLINDETEKT: Define bash commands to run before running KOTLINDETEKT

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_PRE_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_DETEKT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_DETEKT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_DETEKT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_DETEKT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_DETEKT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_DETEKT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_DETEKT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_DETEKT_RULES_PATH

KOTLIN_DETEKT: Custom config file path

Type: string

KOTLIN_DETEKT: Path where to find linter configuration file

root KOTLIN_DETEKT_UNSECURED_ENV_VARIABLES

KOTLIN_DETEKT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling KOTLIN_DETEKT and its pre/post commands

 No Additional Items

Each item of this array must be:

root KOTLIN_DETEKT_UNSECURED_ENV_VARIABLES KOTLIN_DETEKT_UNSECURED_ENV_VARIABLES items
Type: string

root KOTLIN_FILTER_REGEX_EXCLUDE

Excluding regex filter for KOTLIN descriptor

Type: string

KOTLIN: Custom regex excluding filter: files matching this regex will NOT be linted

root KOTLIN_FILTER_REGEX_INCLUDE

Including regex filter for KOTLIN descriptor

Type: string

KOTLIN: Custom regex including filter: only files matching this regex will be linted

root KOTLIN_KTLINT_ARGUMENTS

KOTLIN_KTLINT: Custom arguments

Type: array of string or string

KOTLIN_KTLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_ARGUMENTS KOTLIN_KTLINT_ARGUMENTS items
Type: string

root KOTLIN_KTLINT_CLI_EXECUTABLE

KOTLIN_KTLINT: CLI Executable

Type: array of string Default: [["ktlint"]]

KOTLIN_KTLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_CLI_EXECUTABLE KOTLIN_KTLINT_CLI_EXECUTABLE items
Type: string

root KOTLIN_KTLINT_CLI_LINT_MODE

KOTLIN_KTLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

KOTLIN_KTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS

KOTLIN_KTLINT: Custom remove arguments

Type: array of string or string

KOTLIN_KTLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root KOTLIN_KTLINT_DISABLE_ERRORS

KOTLIN_KTLINT: Disable errors

Type: boolean Default: false

KOTLINKTLINT: If true, KOTLINKTLINT doesn't make MegaLinter fail even if errors are found

root KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN

KOTLIN_KTLINT: Maximum number of errors allowed

Type: number Default: 0

KOTLINKTLINT: If the number of errors found is less than this value, KOTLINKTLINT doesn't make MegaLinter fail

root KOTLIN_KTLINT_FILE_EXTENSIONS

KOTLIN_KTLINT: Matching files extensions

Type: array of string Default: [".kt", ".kts"]

KOTLIN_KTLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_FILE_EXTENSIONS KOTLIN_KTLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root KOTLIN_KTLINT_FILE_NAMES_REGEX

KOTLIN_KTLINT: Matching file name regexes

Type: array of string Default: []

KOTLIN_KTLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_FILE_NAMES_REGEX KOTLIN_KTLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE

KOTLIN_KTLINT: Excluding Regex

Type: string

KOTLIN_KTLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root KOTLIN_KTLINT_FILTER_REGEX_INCLUDE

KOTLIN_KTLINT: Including Regex

Type: string

KOTLIN_KTLINT: Custom regex including filter: only files matching this regex will be linted

root KOTLIN_KTLINT_POST_COMMANDS

KOTLIN_KTLINT: Post-run commands

Type: array

KOTLINKTLINT: Define bash commands to run after running KOTLINKTLINT

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_POST_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_KTLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_KTLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_KTLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_KTLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_KTLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_KTLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_KTLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_KTLINT_PRE_COMMANDS

KOTLIN_KTLINT: Pre-run commands

Type: array

KOTLINKTLINT: Define bash commands to run before running KOTLINKTLINT

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_KTLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_KTLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_KTLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_KTLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_KTLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_KTLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_KTLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES

KOTLIN_KTLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling KOTLIN_KTLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES items
Type: string

root KOTLIN_POST_COMMANDS

Post commands for KOTLIN descriptor

Type: array

KOTLIN: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root KOTLIN_POST_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_POST_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KOTLIN_PRE_COMMANDS

Pre commands for KOTLIN descriptor

Type: array

KOTLIN: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root KOTLIN_PRE_COMMANDS Command

Command

Type: object

Command information

root KOTLIN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KOTLIN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KOTLIN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KOTLIN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KOTLIN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KOTLIN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KOTLIN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KOTLIN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_DIRECTORY

Directory containing KUBERNETES files

Type: string

root KUBERNETES_FILTER_REGEX_EXCLUDE

Excluding regex filter for KUBERNETES descriptor

Type: string

KUBERNETES: Custom regex excluding filter: files matching this regex will NOT be linted

root KUBERNETES_FILTER_REGEX_INCLUDE

Including regex filter for KUBERNETES descriptor

Type: string

KUBERNETES: Custom regex including filter: only files matching this regex will be linted

root KUBERNETES_HELM_ARGUMENTS

KUBERNETES_HELM: Custom arguments

Type: array of string or string

KUBERNETES_HELM: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_ARGUMENTS KUBERNETES_HELM_ARGUMENTS items
Type: string

root KUBERNETES_HELM_CLI_EXECUTABLE

KUBERNETES_HELM: CLI Executable

Type: array of string Default: [["helm"]]

KUBERNETES_HELM: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_CLI_EXECUTABLE KUBERNETES_HELM_CLI_EXECUTABLE items
Type: string

root KUBERNETES_HELM_CLI_LINT_MODE

KUBERNETES_HELM: CLI lint mode

Type: enum (of string) Default: "project"

KUBERNETES_HELM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS

KUBERNETES_HELM: Custom remove arguments

Type: array of string or string

KUBERNETES_HELM: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS items
Type: string

root KUBERNETES_HELM_DIRECTORY

KUBERNETES_HELM: Directory containing KUBERNETES files

Type: string Default: ""

Directory that must be found to activate linter. Use value "any" to always activate

root KUBERNETES_HELM_DISABLE_ERRORS

KUBERNETES_HELM: Disable errors

Type: boolean Default: false

KUBERNETESHELM: If true, KUBERNETESHELM doesn't make MegaLinter fail even if errors are found

root KUBERNETES_HELM_DISABLE_ERRORS_IF_LESS_THAN

KUBERNETES_HELM: Maximum number of errors allowed

Type: number Default: 0

KUBERNETESHELM: If the number of errors found is less than this value, KUBERNETESHELM doesn't make MegaLinter fail

root KUBERNETES_HELM_FILE_EXTENSIONS

KUBERNETES_HELM: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

KUBERNETES_HELM: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_FILE_EXTENSIONS KUBERNETES_HELM_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root KUBERNETES_HELM_FILE_NAMES_REGEX

KUBERNETES_HELM: Matching file name regexes

Type: array of string Default: []

KUBERNETES_HELM: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_FILE_NAMES_REGEX KUBERNETES_HELM_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KUBERNETES_HELM_POST_COMMANDS

KUBERNETES_HELM: Post-run commands

Type: array

KUBERNETESHELM: Define bash commands to run after running KUBERNETESHELM

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_POST_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_HELM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_HELM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_HELM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_HELM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_POST_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_HELM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_HELM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_HELM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_HELM_PRE_COMMANDS

KUBERNETES_HELM: Pre-run commands

Type: array

KUBERNETESHELM: Define bash commands to run before running KUBERNETESHELM

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_PRE_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_HELM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_HELM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_HELM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_HELM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_HELM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_HELM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_HELM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_HELM_UNSECURED_ENV_VARIABLES

KUBERNETES_HELM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling KUBERNETES_HELM and its pre/post commands

 No Additional Items

Each item of this array must be:

root KUBERNETES_HELM_UNSECURED_ENV_VARIABLES KUBERNETES_HELM_UNSECURED_ENV_VARIABLES items
Type: string

root KUBERNETES_KUBECONFORM_ARGUMENTS

KUBERNETES_KUBECONFORM: Custom arguments

Type: array of string or string

KUBERNETES_KUBECONFORM: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_ARGUMENTS KUBERNETES_KUBECONFORM_ARGUMENTS items
Type: string

root KUBERNETES_KUBECONFORM_CLI_EXECUTABLE

KUBERNETES_KUBECONFORM: CLI Executable

Type: array of string Default: [["kubeconform"]]

KUBERNETES_KUBECONFORM: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_CLI_EXECUTABLE KUBERNETES_KUBECONFORM_CLI_EXECUTABLE items
Type: string

root KUBERNETES_KUBECONFORM_CLI_LINT_MODE

KUBERNETES_KUBECONFORM: CLI lint mode

Type: enum (of string) Default: "list_of_files"

KUBERNETES_KUBECONFORM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS

KUBERNETES_KUBECONFORM: Custom remove arguments

Type: array of string or string

KUBERNETES_KUBECONFORM: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS items
Type: string

root KUBERNETES_KUBECONFORM_DIRECTORY

KUBERNETES_KUBECONFORM: Directory containing KUBERNETES files

Type: string Default: "kubernetes"

Directory that must be found to activate linter. Use value "any" to always activate

root KUBERNETES_KUBECONFORM_DISABLE_ERRORS

KUBERNETES_KUBECONFORM: Disable errors

Type: boolean Default: false

KUBERNETESKUBECONFORM: If true, KUBERNETESKUBECONFORM doesn't make MegaLinter fail even if errors are found

root KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN

KUBERNETES_KUBECONFORM: Maximum number of errors allowed

Type: number Default: 0

KUBERNETESKUBECONFORM: If the number of errors found is less than this value, KUBERNETESKUBECONFORM doesn't make MegaLinter fail

root KUBERNETES_KUBECONFORM_FILE_EXTENSIONS

KUBERNETES_KUBECONFORM: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

KUBERNETES_KUBECONFORM: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_FILE_EXTENSIONS KUBERNETES_KUBECONFORM_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX

KUBERNETES_KUBECONFORM: Matching file name regexes

Type: array of string Default: []

KUBERNETES_KUBECONFORM: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE

KUBERNETES_KUBECONFORM: Excluding Regex

Type: string

KUBERNETES_KUBECONFORM: Custom regex excluding filter: files matching this regex will NOT be linted

root KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE

KUBERNETES_KUBECONFORM: Including Regex

Type: string

KUBERNETES_KUBECONFORM: Custom regex including filter: only files matching this regex will be linted

root KUBERNETES_KUBECONFORM_POST_COMMANDS

KUBERNETES_KUBECONFORM: Post-run commands

Type: array

KUBERNETESKUBECONFORM: Define bash commands to run after running KUBERNETESKUBECONFORM

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBECONFORM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_KUBECONFORM_PRE_COMMANDS

KUBERNETES_KUBECONFORM: Pre-run commands

Type: array

KUBERNETESKUBECONFORM: Define bash commands to run before running KUBERNETESKUBECONFORM

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBECONFORM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES

KUBERNETES_KUBECONFORM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling KUBERNETES_KUBECONFORM and its pre/post commands

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES items
Type: string

root KUBERNETES_KUBESCAPE_ARGUMENTS

KUBERNETES_KUBESCAPE: Custom arguments

Type: array of string or string

KUBERNETES_KUBESCAPE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_ARGUMENTS KUBERNETES_KUBESCAPE_ARGUMENTS items
Type: string

root KUBERNETES_KUBESCAPE_CLI_EXECUTABLE

KUBERNETES_KUBESCAPE: CLI Executable

Type: array of string Default: [["kubescape"]]

KUBERNETES_KUBESCAPE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_CLI_EXECUTABLE KUBERNETES_KUBESCAPE_CLI_EXECUTABLE items
Type: string

root KUBERNETES_KUBESCAPE_CLI_LINT_MODE

KUBERNETES_KUBESCAPE: CLI lint mode

Type: enum (of string) Default: "project"

KUBERNETES_KUBESCAPE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS

KUBERNETES_KUBESCAPE: Custom remove arguments

Type: array of string or string

KUBERNETES_KUBESCAPE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root KUBERNETES_KUBESCAPE_DIRECTORY

KUBERNETES_KUBESCAPE: Directory containing KUBERNETES files

Type: string Default: ""

Directory that must be found to activate linter. Use value "any" to always activate

root KUBERNETES_KUBESCAPE_DISABLE_ERRORS

KUBERNETES_KUBESCAPE: Disable errors

Type: boolean Default: false

KUBERNETESKUBESCAPE: If true, KUBERNETESKUBESCAPE doesn't make MegaLinter fail even if errors are found

root KUBERNETES_KUBESCAPE_DISABLE_ERRORS_IF_LESS_THAN

KUBERNETES_KUBESCAPE: Maximum number of errors allowed

Type: number Default: 0

KUBERNETESKUBESCAPE: If the number of errors found is less than this value, KUBERNETESKUBESCAPE doesn't make MegaLinter fail

root KUBERNETES_KUBESCAPE_FILE_EXTENSIONS

KUBERNETES_KUBESCAPE: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

KUBERNETES_KUBESCAPE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_FILE_EXTENSIONS KUBERNETES_KUBESCAPE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX

KUBERNETES_KUBESCAPE: Matching file name regexes

Type: array of string Default: []

KUBERNETES_KUBESCAPE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KUBERNETES_KUBESCAPE_POST_COMMANDS

KUBERNETES_KUBESCAPE: Post-run commands

Type: array

KUBERNETESKUBESCAPE: Define bash commands to run after running KUBERNETESKUBESCAPE

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBESCAPE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_KUBESCAPE_PRE_COMMANDS

KUBERNETES_KUBESCAPE: Pre-run commands

Type: array

KUBERNETESKUBESCAPE: Define bash commands to run before running KUBERNETESKUBESCAPE

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBESCAPE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES

KUBERNETES_KUBESCAPE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling KUBERNETES_KUBESCAPE and its pre/post commands

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES items
Type: string

root KUBERNETES_KUBEVAL_ARGUMENTS

(removed) KUBERNETES_KUBEVAL: Custom arguments

Type: array of string or string

KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_ARGUMENTS KUBERNETES_KUBEVAL_ARGUMENTS items
Type: string

root KUBERNETES_KUBEVAL_CLI_EXECUTABLE

(removed) KUBERNETES_KUBEVAL: CLI Executable

Type: array of string Default: [["kubeval"]]
No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_CLI_EXECUTABLE KUBERNETES_KUBEVAL_CLI_EXECUTABLE items
Type: string

root KUBERNETES_KUBEVAL_CLI_LINT_MODE

(removed) KUBERNETES_KUBEVAL: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

root KUBERNETES_KUBEVAL_DIRECTORY

(removed) KUBERNETES_KUBEVAL: Directory containing KUBERNETES files

Type: string Default: "kubernetes"

root KUBERNETES_KUBEVAL_DISABLE_ERRORS

(removed) KUBERNETES_KUBEVAL: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN

(removed) KUBERNETES_KUBEVAL: Maximum number of errors allowed

Type: number Default: 0

root KUBERNETES_KUBEVAL_FILE_EXTENSIONS

(removed) KUBERNETES_KUBEVAL: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_FILE_EXTENSIONS KUBERNETES_KUBEVAL_FILE_EXTENSIONS items
Type: string

root KUBERNETES_KUBEVAL_FILE_NAMES_REGEX

(removed) KUBERNETES_KUBEVAL: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_FILE_NAMES_REGEX KUBERNETES_KUBEVAL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE

(removed) KUBERNETES_KUBEVAL: Excluding Regex

Type: string

root KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE

(removed) KUBERNETES_KUBEVAL: Including Regex

Type: string

root KUBERNETES_KUBEVAL_POST_COMMANDS

(removed) KUBERNETES_KUBEVAL: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_POST_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBEVAL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBEVAL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBEVAL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBEVAL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_POST_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBEVAL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBEVAL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBEVAL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_KUBEVAL_PRE_COMMANDS

(removed) KUBERNETES_KUBEVAL: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_KUBEVAL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_POST_COMMANDS

Post commands for KUBERNETES descriptor

Type: array

KUBERNETES: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root KUBERNETES_POST_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_POST_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root KUBERNETES_PRE_COMMANDS

Pre commands for KUBERNETES descriptor

Type: array

KUBERNETES: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root KUBERNETES_PRE_COMMANDS Command

Command

Type: object

Command information

root KUBERNETES_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root KUBERNETES_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root KUBERNETES_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root KUBERNETES_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root KUBERNETES_PRE_COMMANDS Command output_variables output_variables items
Type: string

root KUBERNETES_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root KUBERNETES_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root KUBERNETES_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LATEX_CHKTEX_ARGUMENTS

LATEX_CHKTEX: Custom arguments

Type: array of string or string

LATEX_CHKTEX: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_ARGUMENTS LATEX_CHKTEX_ARGUMENTS items
Type: string

root LATEX_CHKTEX_CLI_EXECUTABLE

LATEX_CHKTEX: CLI Executable

Type: array of string Default: [["chktex"]]

LATEX_CHKTEX: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_CLI_EXECUTABLE LATEX_CHKTEX_CLI_EXECUTABLE items
Type: string

root LATEX_CHKTEX_CLI_LINT_MODE

LATEX_CHKTEX: CLI lint mode

Type: enum (of string) Default: "file"

LATEX_CHKTEX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS

LATEX_CHKTEX: Custom remove arguments

Type: array of string or string

LATEX_CHKTEX: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS items
Type: string

root LATEX_CHKTEX_CONFIG_FILE

LATEX_CHKTEX: Custom config file name

Type: string Default: ".chktexrc"

LATEX_CHKTEX: User custom config file name if different from default

root LATEX_CHKTEX_DISABLE_ERRORS

LATEX_CHKTEX: Disable errors

Type: boolean Default: false

LATEXCHKTEX: If true, LATEXCHKTEX doesn't make MegaLinter fail even if errors are found

root LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN

LATEX_CHKTEX: Maximum number of errors allowed

Type: number Default: 0

LATEXCHKTEX: If the number of errors found is less than this value, LATEXCHKTEX doesn't make MegaLinter fail

root LATEX_CHKTEX_FILE_EXTENSIONS

LATEX_CHKTEX: Matching files extensions

Type: array of string Default: [".tex"]

LATEX_CHKTEX: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_FILE_EXTENSIONS LATEX_CHKTEX_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root LATEX_CHKTEX_FILE_NAMES_REGEX

LATEX_CHKTEX: Matching file name regexes

Type: array of string Default: []

LATEX_CHKTEX: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_FILE_NAMES_REGEX LATEX_CHKTEX_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root LATEX_CHKTEX_FILTER_REGEX_EXCLUDE

LATEX_CHKTEX: Excluding Regex

Type: string

LATEX_CHKTEX: Custom regex excluding filter: files matching this regex will NOT be linted

root LATEX_CHKTEX_FILTER_REGEX_INCLUDE

LATEX_CHKTEX: Including Regex

Type: string

LATEX_CHKTEX: Custom regex including filter: only files matching this regex will be linted

root LATEX_CHKTEX_POST_COMMANDS

LATEX_CHKTEX: Post-run commands

Type: array

LATEXCHKTEX: Define bash commands to run after running LATEXCHKTEX

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_POST_COMMANDS Command

Command

Type: object

Command information

root LATEX_CHKTEX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LATEX_CHKTEX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LATEX_CHKTEX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LATEX_CHKTEX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_POST_COMMANDS Command output_variables output_variables items
Type: string

root LATEX_CHKTEX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LATEX_CHKTEX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LATEX_CHKTEX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LATEX_CHKTEX_PRE_COMMANDS

LATEX_CHKTEX: Pre-run commands

Type: array

LATEXCHKTEX: Define bash commands to run before running LATEXCHKTEX

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_PRE_COMMANDS Command

Command

Type: object

Command information

root LATEX_CHKTEX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LATEX_CHKTEX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LATEX_CHKTEX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LATEX_CHKTEX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LATEX_CHKTEX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LATEX_CHKTEX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LATEX_CHKTEX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LATEX_CHKTEX_RULES_PATH

LATEX_CHKTEX: Custom config file path

Type: string

LATEX_CHKTEX: Path where to find linter configuration file

root LATEX_CHKTEX_UNSECURED_ENV_VARIABLES

LATEX_CHKTEX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling LATEX_CHKTEX and its pre/post commands

 No Additional Items

Each item of this array must be:

root LATEX_CHKTEX_UNSECURED_ENV_VARIABLES LATEX_CHKTEX_UNSECURED_ENV_VARIABLES items
Type: string

root LATEX_FILTER_REGEX_EXCLUDE

Excluding regex filter for LATEX descriptor

Type: string

LATEX: Custom regex excluding filter: files matching this regex will NOT be linted

root LATEX_FILTER_REGEX_INCLUDE

Including regex filter for LATEX descriptor

Type: string

LATEX: Custom regex including filter: only files matching this regex will be linted

root LATEX_POST_COMMANDS

Post commands for LATEX descriptor

Type: array

LATEX: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root LATEX_POST_COMMANDS Command

Command

Type: object

Command information

root LATEX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LATEX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LATEX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LATEX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LATEX_POST_COMMANDS Command output_variables output_variables items
Type: string

root LATEX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LATEX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LATEX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LATEX_PRE_COMMANDS

Pre commands for LATEX descriptor

Type: array

LATEX: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root LATEX_PRE_COMMANDS Command

Command

Type: object

Command information

root LATEX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LATEX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LATEX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LATEX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LATEX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LATEX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LATEX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LATEX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LINTER_RULES_PATH

Linter rules path

Type: string Default: ".github/linters"

Directory for all linter configuration rules. Can be a local folder or a remote URL. Not necessary if your linters configuration files are at the root of your repository
Examples:

"myrulesfolder"

"https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules"

root LLM_ADVISOR_DISABLE_LINTERS

LLM Advisor Disabled linter keys

Type: array

If LLMADVISORDISABLE_LINTERS is set, LLM advisor will NOT process these ones

 No Additional Items

Each item of this array must be:

root LLM_ADVISOR_DISABLE_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

root LLM_ADVISOR_ENABLED

LLM Advisor enabled

Type: boolean Default: false

Enable AI-powered fix suggestions using Large Language Models
Examples:

true

false

root LLM_ADVISOR_ENABLE_LINTERS

LLM Advisor Enabled linter keys

Type: array

If LLMADVISORENABLE_LINTERS is set, LLM advisor will only process these ones

 No Additional Items

Each item of this array must be:

root LLM_ADVISOR_ENABLE_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

root LLM_ADVISOR_LEVEL

LLM Advisor trigger level

Type: enum (of string) Default: "ERROR"

When to trigger AI suggestions: ERROR (only for blocking linters with return_code != 0) or WARNING (for both blocking and non-blocking linters)

Must be one of:

  • "ERROR"
  • "WARNING"

Examples:

"ERROR"

"WARNING"

root LLM_ADVISOR_POSITION

LLM Advisor trigger level

Type: enum (of string) Default: "after_linter_output"

Display LLM Advisor suggestions before or after linter output

Must be one of:

  • "after_linter_output"
  • "before_linter_output"

Examples:

"after_linter_output"

"before_linter_output"

root LLM_MAX_TOKENS

LLM maximum tokens

Type: string Default: "1000"

Maximum number of tokens for LLM response
Examples:

"500"

"1000"

"2000"

root LLM_MODEL_NAME

LLM model name

Type: string

Name of the LLM model to use (provider-specific)
Examples:

"gpt-3.5-turbo"

"gpt-4"

"claude-3-haiku-20240307"

"gemini-pro"

root LLM_PROVIDER

LLM provider

Type: enum (of string) Default: "openai"

LLM provider to use for AI suggestions

Must be one of:

  • "openai"
  • "anthropic"
  • "google"
  • "huggingface"
  • "mistral"
  • "deepseek"
  • "grok"
  • "ollama"

Examples:

"openai"

"anthropic"

"google"

"ollama"

root LLM_TEMPERATURE

LLM temperature

Type: string Default: "0.1"

Temperature for LLM generation (0.0 = deterministic, 1.0 = creative)
Examples:

"0.0"

"0.1"

"0.5"

"1.0"

root LOG_FILE

Log file name

Type: string Default: "mega-linter.log"

The file name for outputting logs. All output is sent to the log file regardless of LOG_LEVEL

root LOG_LEVEL

Log level

Type: enum (of string) Default: "INFO"

How much output the script will generate to the console. One of INFO, DEBUG, WARNING or ERROR.

Must be one of:

  • "INFO"
  • "DEBUG"
  • "WARNING"
  • "ERROR"

root LUA_FILTER_REGEX_EXCLUDE

Excluding regex filter for LUA descriptor

Type: string

LUA: Custom regex excluding filter: files matching this regex will NOT be linted

root LUA_FILTER_REGEX_INCLUDE

Including regex filter for LUA descriptor

Type: string

LUA: Custom regex including filter: only files matching this regex will be linted

root LUA_LUACHECK_ARGUMENTS

LUA_LUACHECK: Custom arguments

Type: array of string or string

LUA_LUACHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_ARGUMENTS LUA_LUACHECK_ARGUMENTS items
Type: string

root LUA_LUACHECK_CLI_EXECUTABLE

LUA_LUACHECK: CLI Executable

Type: array of string Default: [["luacheck"]]

LUA_LUACHECK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_CLI_EXECUTABLE LUA_LUACHECK_CLI_EXECUTABLE items
Type: string

root LUA_LUACHECK_CLI_LINT_MODE

LUA_LUACHECK: CLI lint mode

Type: enum (of string) Default: "file"

LUA_LUACHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS

LUA_LUACHECK: Custom remove arguments

Type: array of string or string

LUA_LUACHECK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root LUA_LUACHECK_CONFIG_FILE

LUA_LUACHECK: Custom config file name

Type: string Default: ".luacheckrc"

LUA_LUACHECK: User custom config file name if different from default

root LUA_LUACHECK_DISABLE_ERRORS

LUA_LUACHECK: Disable errors

Type: boolean Default: false

LUALUACHECK: If true, LUALUACHECK doesn't make MegaLinter fail even if errors are found

root LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN

LUA_LUACHECK: Maximum number of errors allowed

Type: number Default: 0

LUALUACHECK: If the number of errors found is less than this value, LUALUACHECK doesn't make MegaLinter fail

root LUA_LUACHECK_FILE_EXTENSIONS

LUA_LUACHECK: Matching files extensions

Type: array of string Default: [".lua"]

LUA_LUACHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_FILE_EXTENSIONS LUA_LUACHECK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root LUA_LUACHECK_FILE_NAMES_REGEX

LUA_LUACHECK: Matching file name regexes

Type: array of string Default: []

LUA_LUACHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_FILE_NAMES_REGEX LUA_LUACHECK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root LUA_LUACHECK_FILTER_REGEX_EXCLUDE

LUA_LUACHECK: Excluding Regex

Type: string

LUA_LUACHECK: Custom regex excluding filter: files matching this regex will NOT be linted

root LUA_LUACHECK_FILTER_REGEX_INCLUDE

LUA_LUACHECK: Including Regex

Type: string

LUA_LUACHECK: Custom regex including filter: only files matching this regex will be linted

root LUA_LUACHECK_POST_COMMANDS

LUA_LUACHECK: Post-run commands

Type: array

LUALUACHECK: Define bash commands to run after running LUALUACHECK

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_POST_COMMANDS Command

Command

Type: object

Command information

root LUA_LUACHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_LUACHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_LUACHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_LUACHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root LUA_LUACHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_LUACHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_LUACHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_LUACHECK_PRE_COMMANDS

LUA_LUACHECK: Pre-run commands

Type: array

LUALUACHECK: Define bash commands to run before running LUALUACHECK

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root LUA_LUACHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_LUACHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_LUACHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_LUACHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LUA_LUACHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_LUACHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_LUACHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_LUACHECK_RULES_PATH

LUA_LUACHECK: Custom config file path

Type: string

LUA_LUACHECK: Path where to find linter configuration file

root LUA_LUACHECK_UNSECURED_ENV_VARIABLES

LUA_LUACHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling LUA_LUACHECK and its pre/post commands

 No Additional Items

Each item of this array must be:

root LUA_LUACHECK_UNSECURED_ENV_VARIABLES LUA_LUACHECK_UNSECURED_ENV_VARIABLES items
Type: string

root LUA_POST_COMMANDS

Post commands for LUA descriptor

Type: array

LUA: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root LUA_POST_COMMANDS Command

Command

Type: object

Command information

root LUA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_POST_COMMANDS Command output_variables output_variables items
Type: string

root LUA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_PRE_COMMANDS

Pre commands for LUA descriptor

Type: array

LUA: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root LUA_PRE_COMMANDS Command

Command

Type: object

Command information

root LUA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LUA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_SELENE_ARGUMENTS

LUA_SELENE: Custom arguments

Type: array of string or string

LUA_SELENE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root LUA_SELENE_ARGUMENTS LUA_SELENE_ARGUMENTS items
Type: string

root LUA_SELENE_CLI_EXECUTABLE

LUA_SELENE: CLI Executable

Type: array of string Default: [["selene"]]

LUA_SELENE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root LUA_SELENE_CLI_EXECUTABLE LUA_SELENE_CLI_EXECUTABLE items
Type: string

root LUA_SELENE_CLI_LINT_MODE

LUA_SELENE: CLI lint mode

Type: enum (of string) Default: "file"

LUA_SELENE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root LUA_SELENE_COMMAND_REMOVE_ARGUMENTS

LUA_SELENE: Custom remove arguments

Type: array of string or string

LUA_SELENE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root LUA_SELENE_COMMAND_REMOVE_ARGUMENTS LUA_SELENE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root LUA_SELENE_CONFIG_FILE

LUA_SELENE: Custom config file name

Type: string Default: "selene.toml"

LUA_SELENE: User custom config file name if different from default

root LUA_SELENE_DISABLE_ERRORS

LUA_SELENE: Disable errors

Type: boolean Default: false

LUASELENE: If true, LUASELENE doesn't make MegaLinter fail even if errors are found

root LUA_SELENE_DISABLE_ERRORS_IF_LESS_THAN

LUA_SELENE: Maximum number of errors allowed

Type: number Default: 0

LUASELENE: If the number of errors found is less than this value, LUASELENE doesn't make MegaLinter fail

root LUA_SELENE_FILE_EXTENSIONS

LUA_SELENE: Matching files extensions

Type: array of string Default: [".lua"]

LUA_SELENE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_SELENE_FILE_EXTENSIONS LUA_SELENE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root LUA_SELENE_FILE_NAMES_REGEX

LUA_SELENE: Matching file name regexes

Type: array of string Default: []

LUA_SELENE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_SELENE_FILE_NAMES_REGEX LUA_SELENE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root LUA_SELENE_FILTER_REGEX_EXCLUDE

LUA_SELENE: Excluding Regex

Type: string

LUA_SELENE: Custom regex excluding filter: files matching this regex will NOT be linted

root LUA_SELENE_FILTER_REGEX_INCLUDE

LUA_SELENE: Including Regex

Type: string

LUA_SELENE: Custom regex including filter: only files matching this regex will be linted

root LUA_SELENE_POST_COMMANDS

LUA_SELENE: Post-run commands

Type: array

LUASELENE: Define bash commands to run after running LUASELENE

 No Additional Items

Each item of this array must be:

root LUA_SELENE_POST_COMMANDS Command

Command

Type: object

Command information

root LUA_SELENE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_SELENE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_SELENE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_SELENE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_SELENE_POST_COMMANDS Command output_variables output_variables items
Type: string

root LUA_SELENE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_SELENE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_SELENE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_SELENE_PRE_COMMANDS

LUA_SELENE: Pre-run commands

Type: array

LUASELENE: Define bash commands to run before running LUASELENE

 No Additional Items

Each item of this array must be:

root LUA_SELENE_PRE_COMMANDS Command

Command

Type: object

Command information

root LUA_SELENE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_SELENE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_SELENE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_SELENE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_SELENE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LUA_SELENE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_SELENE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_SELENE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_SELENE_RULES_PATH

LUA_SELENE: Custom config file path

Type: string

LUA_SELENE: Path where to find linter configuration file

root LUA_SELENE_UNSECURED_ENV_VARIABLES

LUA_SELENE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling LUA_SELENE and its pre/post commands

 No Additional Items

Each item of this array must be:

root LUA_SELENE_UNSECURED_ENV_VARIABLES LUA_SELENE_UNSECURED_ENV_VARIABLES items
Type: string

root LUA_STYLUA_ARGUMENTS

LUA_STYLUA: Custom arguments

Type: array of string or string

LUA_STYLUA: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_ARGUMENTS LUA_STYLUA_ARGUMENTS items
Type: string

root LUA_STYLUA_CLI_EXECUTABLE

LUA_STYLUA: CLI Executable

Type: array of string Default: [["stylua"]]

LUA_STYLUA: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_CLI_EXECUTABLE LUA_STYLUA_CLI_EXECUTABLE items
Type: string

root LUA_STYLUA_CLI_LINT_MODE

LUA_STYLUA: CLI lint mode

Type: enum (of string) Default: "file"

LUA_STYLUA: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root LUA_STYLUA_COMMAND_REMOVE_ARGUMENTS

LUA_STYLUA: Custom remove arguments

Type: array of string or string

LUA_STYLUA: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_COMMAND_REMOVE_ARGUMENTS LUA_STYLUA_COMMAND_REMOVE_ARGUMENTS items
Type: string

root LUA_STYLUA_CONFIG_FILE

LUA_STYLUA: Custom config file name

Type: string Default: "stylua.toml"

LUA_STYLUA: User custom config file name if different from default

root LUA_STYLUA_DISABLE_ERRORS

LUA_STYLUA: Disable errors

Type: boolean Default: false

LUASTYLUA: If true, LUASTYLUA doesn't make MegaLinter fail even if errors are found

root LUA_STYLUA_DISABLE_ERRORS_IF_LESS_THAN

LUA_STYLUA: Maximum number of errors allowed

Type: number Default: 0

LUASTYLUA: If the number of errors found is less than this value, LUASTYLUA doesn't make MegaLinter fail

root LUA_STYLUA_FILE_EXTENSIONS

LUA_STYLUA: Matching files extensions

Type: array of string Default: [".lua"]

LUA_STYLUA: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_FILE_EXTENSIONS LUA_STYLUA_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root LUA_STYLUA_FILE_NAMES_REGEX

LUA_STYLUA: Matching file name regexes

Type: array of string Default: []

LUA_STYLUA: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_FILE_NAMES_REGEX LUA_STYLUA_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root LUA_STYLUA_FILTER_REGEX_EXCLUDE

LUA_STYLUA: Excluding Regex

Type: string

LUA_STYLUA: Custom regex excluding filter: files matching this regex will NOT be linted

root LUA_STYLUA_FILTER_REGEX_INCLUDE

LUA_STYLUA: Including Regex

Type: string

LUA_STYLUA: Custom regex including filter: only files matching this regex will be linted

root LUA_STYLUA_POST_COMMANDS

LUA_STYLUA: Post-run commands

Type: array

LUASTYLUA: Define bash commands to run after running LUASTYLUA

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_POST_COMMANDS Command

Command

Type: object

Command information

root LUA_STYLUA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_STYLUA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_STYLUA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_STYLUA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_POST_COMMANDS Command output_variables output_variables items
Type: string

root LUA_STYLUA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_STYLUA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_STYLUA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_STYLUA_PRE_COMMANDS

LUA_STYLUA: Pre-run commands

Type: array

LUASTYLUA: Define bash commands to run before running LUASTYLUA

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_PRE_COMMANDS Command

Command

Type: object

Command information

root LUA_STYLUA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root LUA_STYLUA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root LUA_STYLUA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root LUA_STYLUA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root LUA_STYLUA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root LUA_STYLUA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root LUA_STYLUA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root LUA_STYLUA_RULES_PATH

LUA_STYLUA: Custom config file path

Type: string

LUA_STYLUA: Path where to find linter configuration file

root LUA_STYLUA_UNSECURED_ENV_VARIABLES

LUA_STYLUA: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling LUA_STYLUA and its pre/post commands

 No Additional Items

Each item of this array must be:

root LUA_STYLUA_UNSECURED_ENV_VARIABLES LUA_STYLUA_UNSECURED_ENV_VARIABLES items
Type: string

root MAKEFILE_CHECKMAKE_ARGUMENTS

MAKEFILE_CHECKMAKE: Custom arguments

Type: array of string or string

MAKEFILE_CHECKMAKE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_ARGUMENTS MAKEFILE_CHECKMAKE_ARGUMENTS items
Type: string

root MAKEFILE_CHECKMAKE_CLI_EXECUTABLE

MAKEFILE_CHECKMAKE: CLI Executable

Type: array of string Default: [["checkmake"]]

MAKEFILE_CHECKMAKE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_CLI_EXECUTABLE MAKEFILE_CHECKMAKE_CLI_EXECUTABLE items
Type: string

root MAKEFILE_CHECKMAKE_CLI_LINT_MODE

MAKEFILE_CHECKMAKE: CLI lint mode

Type: enum (of string) Default: "file"

MAKEFILE_CHECKMAKE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS

MAKEFILE_CHECKMAKE: Custom remove arguments

Type: array of string or string

MAKEFILE_CHECKMAKE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root MAKEFILE_CHECKMAKE_CONFIG_FILE

MAKEFILE_CHECKMAKE: Custom config file name

Type: string Default: ".checkmake.ini"

MAKEFILE_CHECKMAKE: User custom config file name if different from default

root MAKEFILE_CHECKMAKE_DISABLE_ERRORS

MAKEFILE_CHECKMAKE: Disable errors

Type: boolean Default: false

MAKEFILECHECKMAKE: If true, MAKEFILECHECKMAKE doesn't make MegaLinter fail even if errors are found

root MAKEFILE_CHECKMAKE_DISABLE_ERRORS_IF_LESS_THAN

MAKEFILE_CHECKMAKE: Maximum number of errors allowed

Type: number Default: 0

MAKEFILECHECKMAKE: If the number of errors found is less than this value, MAKEFILECHECKMAKE doesn't make MegaLinter fail

root MAKEFILE_CHECKMAKE_FILE_EXTENSIONS

MAKEFILE_CHECKMAKE: Matching files extensions

Type: array of string Default: []

MAKEFILE_CHECKMAKE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_FILE_EXTENSIONS MAKEFILE_CHECKMAKE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX

MAKEFILE_CHECKMAKE: Matching file name regexes

Type: array of string Default: ["Makefile"]

MAKEFILE_CHECKMAKE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MAKEFILE_CHECKMAKE_FILTER_REGEX_EXCLUDE

MAKEFILE_CHECKMAKE: Excluding Regex

Type: string

MAKEFILE_CHECKMAKE: Custom regex excluding filter: files matching this regex will NOT be linted

root MAKEFILE_CHECKMAKE_FILTER_REGEX_INCLUDE

MAKEFILE_CHECKMAKE: Including Regex

Type: string

MAKEFILE_CHECKMAKE: Custom regex including filter: only files matching this regex will be linted

root MAKEFILE_CHECKMAKE_POST_COMMANDS

MAKEFILE_CHECKMAKE: Post-run commands

Type: array

MAKEFILECHECKMAKE: Define bash commands to run after running MAKEFILECHECKMAKE

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command

Command

Type: object

Command information

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command output_variables output_variables items
Type: string

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MAKEFILE_CHECKMAKE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MAKEFILE_CHECKMAKE_PRE_COMMANDS

MAKEFILE_CHECKMAKE: Pre-run commands

Type: array

MAKEFILECHECKMAKE: Define bash commands to run before running MAKEFILECHECKMAKE

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command

Command

Type: object

Command information

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MAKEFILE_CHECKMAKE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MAKEFILE_CHECKMAKE_RULES_PATH

MAKEFILE_CHECKMAKE: Custom config file path

Type: string

MAKEFILE_CHECKMAKE: Path where to find linter configuration file

root MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES

MAKEFILE_CHECKMAKE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling MAKEFILE_CHECKMAKE and its pre/post commands

 No Additional Items

Each item of this array must be:

root MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES items
Type: string

root MAKEFILE_FILTER_REGEX_EXCLUDE

Excluding regex filter for MAKEFILE descriptor

Type: string

MAKEFILE: Custom regex excluding filter: files matching this regex will NOT be linted

root MAKEFILE_FILTER_REGEX_INCLUDE

Including regex filter for MAKEFILE descriptor

Type: string

MAKEFILE: Custom regex including filter: only files matching this regex will be linted

root MAKEFILE_POST_COMMANDS

Post commands for MAKEFILE descriptor

Type: array

MAKEFILE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root MAKEFILE_POST_COMMANDS Command

Command

Type: object

Command information

root MAKEFILE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MAKEFILE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MAKEFILE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MAKEFILE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MAKEFILE_POST_COMMANDS Command output_variables output_variables items
Type: string

root MAKEFILE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MAKEFILE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MAKEFILE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MAKEFILE_PRE_COMMANDS

Pre commands for MAKEFILE descriptor

Type: array

MAKEFILE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root MAKEFILE_PRE_COMMANDS Command

Command

Type: object

Command information

root MAKEFILE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MAKEFILE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MAKEFILE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MAKEFILE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MAKEFILE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MAKEFILE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MAKEFILE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MAKEFILE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_DEFAULT_STYLE

Markdown default formatting style

Type: enum (of string) Default: "markdownlint"

Style of markdown formatting to apply

Must be one of:

  • "markdownlint"
  • "remark-lint"
  • "rumdl"

root MARKDOWN_FILTER_REGEX_EXCLUDE

Excluding regex filter for MARKDOWN descriptor

Type: string

MARKDOWN: Custom regex excluding filter: files matching this regex will NOT be linted

root MARKDOWN_FILTER_REGEX_INCLUDE

Including regex filter for MARKDOWN descriptor

Type: string

MARKDOWN: Custom regex including filter: only files matching this regex will be linted

root MARKDOWN_MARKDOWNLINT_ARGUMENTS

MARKDOWN_MARKDOWNLINT: Custom arguments

Type: array of string or string

MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_ARGUMENTS MARKDOWN_MARKDOWNLINT_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE

MARKDOWN_MARKDOWNLINT: CLI Executable

Type: array of string Default: [["markdownlint"]]

MARKDOWN_MARKDOWNLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE items
Type: string

root MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE

MARKDOWN_MARKDOWNLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

MARKDOWN_MARKDOWNLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS

MARKDOWN_MARKDOWNLINT: Custom remove arguments

Type: array of string or string

MARKDOWN_MARKDOWNLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWNLINT_CONFIG_FILE

MARKDOWN_MARKDOWNLINT: Custom config file name

Type: string Default: ".markdownlint.json"

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

root MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS

MARKDOWN_MARKDOWNLINT: Disable errors

Type: boolean Default: false

MARKDOWNMARKDOWNLINT: If true, MARKDOWNMARKDOWNLINT doesn't make MegaLinter fail even if errors are found

root MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN

MARKDOWN_MARKDOWNLINT: Maximum number of errors allowed

Type: number Default: 0

MARKDOWNMARKDOWNLINT: If the number of errors found is less than this value, MARKDOWNMARKDOWNLINT doesn't make MegaLinter fail

root MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS

MARKDOWN_MARKDOWNLINT: Matching files extensions

Type: array of string Default: [".md"]

MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX

MARKDOWN_MARKDOWNLINT: Matching file name regexes

Type: array of string Default: []

MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE

MARKDOWN_MARKDOWNLINT: Excluding Regex

Type: string

MARKDOWN_MARKDOWNLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE

MARKDOWN_MARKDOWNLINT: Including Regex

Type: string

MARKDOWN_MARKDOWNLINT: Custom regex including filter: only files matching this regex will be linted

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS

MARKDOWN_MARKDOWNLINT: Post-run commands

Type: array

MARKDOWNMARKDOWNLINT: Define bash commands to run after running MARKDOWNMARKDOWNLINT

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS

MARKDOWN_MARKDOWNLINT: Pre-run commands

Type: array

MARKDOWNMARKDOWNLINT: Define bash commands to run before running MARKDOWNMARKDOWNLINT

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_MARKDOWNLINT_RULES_PATH

MARKDOWN_MARKDOWNLINT: Custom config file path

Type: string

MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file

root MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES

MARKDOWN_MARKDOWNLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWNLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES items
Type: string

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS

(deprecated) MARKDOWN_MARKDOWN_LINK_CHECK: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom arguments

Type: array of string or string

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE

MARKDOWN_MARKDOWN_TABLE_FORMATTER: CLI Executable

Type: array of string Default: [["markdown-table-formatter"]]

MARKDOWNMARKDOWNTABLE_FORMATTER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE

MARKDOWN_MARKDOWN_TABLE_FORMATTER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

MARKDOWNMARKDOWNTABLE_FORMATTER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom remove arguments

Type: array of string or string

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Disable errors

Type: boolean Default: false

MARKDOWNMARKDOWNTABLEFORMATTER: If true, MARKDOWNMARKDOWNTABLEFORMATTER doesn't make MegaLinter fail even if errors are found

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Maximum number of errors allowed

Type: number Default: 0

MARKDOWNMARKDOWNTABLEFORMATTER: If the number of errors found is less than this value, MARKDOWNMARKDOWNTABLEFORMATTER doesn't make MegaLinter fail

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Matching files extensions

Type: array of string Default: [".md"]

MARKDOWNMARKDOWNTABLE_FORMATTER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Matching file name regexes

Type: array of string Default: []

MARKDOWNMARKDOWNTABLE_FORMATTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Excluding Regex

Type: string

MARKDOWNMARKDOWNTABLE_FORMATTER: Custom regex excluding filter: files matching this regex will NOT be linted

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Including Regex

Type: string

MARKDOWNMARKDOWNTABLE_FORMATTER: Custom regex including filter: only files matching this regex will be linted

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Post-run commands

Type: array

MARKDOWNMARKDOWNTABLEFORMATTER: Define bash commands to run after running MARKDOWNMARKDOWNTABLEFORMATTER

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Pre-run commands

Type: array

MARKDOWNMARKDOWNTABLEFORMATTER: Define bash commands to run before running MARKDOWNMARKDOWNTABLEFORMATTER

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling MARKDOWNMARKDOWNTABLE_FORMATTER and its pre/post commands

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES items
Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Custom arguments

Type: array of string

MARKDOWNMARKDOWNTABLE_PRETTIFY: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_EXCLUDE

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Excluding Regex

Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_INCLUDE

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Including Regex

Type: string

root MARKDOWN_POST_COMMANDS

Post commands for MARKDOWN descriptor

Type: array

MARKDOWN: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root MARKDOWN_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_PRE_COMMANDS

Pre commands for MARKDOWN descriptor

Type: array

MARKDOWN: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root MARKDOWN_PRE_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_REMARK_LINT_ARGUMENTS

MARKDOWN_REMARK_LINT: Custom arguments

Type: array of string or string

MARKDOWNREMARKLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_ARGUMENTS MARKDOWN_REMARK_LINT_ARGUMENTS items
Type: string

root MARKDOWN_REMARK_LINT_CLI_EXECUTABLE

MARKDOWN_REMARK_LINT: CLI Executable

Type: array of string Default: [["remark"]]

MARKDOWNREMARKLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_CLI_EXECUTABLE MARKDOWN_REMARK_LINT_CLI_EXECUTABLE items
Type: string

root MARKDOWN_REMARK_LINT_CLI_LINT_MODE

MARKDOWN_REMARK_LINT: CLI lint mode

Type: enum (of string) Default: "file"

MARKDOWNREMARKLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS

MARKDOWN_REMARK_LINT: Custom remove arguments

Type: array of string or string

MARKDOWNREMARKLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root MARKDOWN_REMARK_LINT_CONFIG_FILE

MARKDOWN_REMARK_LINT: Custom config file name

Type: string Default: ".remarkrc"

MARKDOWNREMARKLINT: User custom config file name if different from default

root MARKDOWN_REMARK_LINT_DISABLE_ERRORS

MARKDOWN_REMARK_LINT: Disable errors

Type: boolean Default: false

MARKDOWNREMARKLINT: If true, MARKDOWNREMARKLINT doesn't make MegaLinter fail even if errors are found

root MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN

MARKDOWN_REMARK_LINT: Maximum number of errors allowed

Type: number Default: 0

MARKDOWNREMARKLINT: If the number of errors found is less than this value, MARKDOWNREMARKLINT doesn't make MegaLinter fail

root MARKDOWN_REMARK_LINT_FILE_EXTENSIONS

MARKDOWN_REMARK_LINT: Matching files extensions

Type: array of string Default: [".md"]

MARKDOWNREMARKLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_FILE_EXTENSIONS MARKDOWN_REMARK_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX

MARKDOWN_REMARK_LINT: Matching file name regexes

Type: array of string Default: []

MARKDOWNREMARKLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE

MARKDOWN_REMARK_LINT: Excluding Regex

Type: string

MARKDOWNREMARKLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE

MARKDOWN_REMARK_LINT: Including Regex

Type: string

MARKDOWNREMARKLINT: Custom regex including filter: only files matching this regex will be linted

root MARKDOWN_REMARK_LINT_POST_COMMANDS

MARKDOWN_REMARK_LINT: Post-run commands

Type: array

MARKDOWNREMARKLINT: Define bash commands to run after running MARKDOWNREMARKLINT

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_REMARK_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_REMARK_LINT_PRE_COMMANDS

MARKDOWN_REMARK_LINT: Pre-run commands

Type: array

MARKDOWNREMARKLINT: Define bash commands to run before running MARKDOWNREMARKLINT

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_REMARK_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_REMARK_LINT_RULES_PATH

MARKDOWN_REMARK_LINT: Custom config file path

Type: string

MARKDOWNREMARKLINT: Path where to find linter configuration file

root MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES

MARKDOWN_REMARK_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling MARKDOWNREMARKLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root MARKDOWN_RUMDL_ARGUMENTS

MARKDOWN_RUMDL: Custom arguments

Type: array of string or string

MARKDOWN_RUMDL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_ARGUMENTS MARKDOWN_RUMDL_ARGUMENTS items
Type: string

root MARKDOWN_RUMDL_CLI_EXECUTABLE

MARKDOWN_RUMDL: CLI Executable

Type: array of string Default: [["rumdl"]]

MARKDOWN_RUMDL: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_CLI_EXECUTABLE MARKDOWN_RUMDL_CLI_EXECUTABLE items
Type: string

root MARKDOWN_RUMDL_CLI_LINT_MODE

MARKDOWN_RUMDL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

MARKDOWN_RUMDL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root MARKDOWN_RUMDL_COMMAND_REMOVE_ARGUMENTS

MARKDOWN_RUMDL: Custom remove arguments

Type: array of string or string

MARKDOWN_RUMDL: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_COMMAND_REMOVE_ARGUMENTS MARKDOWN_RUMDL_COMMAND_REMOVE_ARGUMENTS items
Type: string

root MARKDOWN_RUMDL_CONFIG_FILE

MARKDOWN_RUMDL: Custom config file name

Type: string Default: ".rumdl.toml"

MARKDOWN_RUMDL: User custom config file name if different from default

root MARKDOWN_RUMDL_DISABLE_ERRORS

MARKDOWN_RUMDL: Disable errors

Type: boolean Default: false

MARKDOWNRUMDL: If true, MARKDOWNRUMDL doesn't make MegaLinter fail even if errors are found

root MARKDOWN_RUMDL_DISABLE_ERRORS_IF_LESS_THAN

MARKDOWN_RUMDL: Maximum number of errors allowed

Type: number Default: 0

MARKDOWNRUMDL: If the number of errors found is less than this value, MARKDOWNRUMDL doesn't make MegaLinter fail

root MARKDOWN_RUMDL_FILE_EXTENSIONS

MARKDOWN_RUMDL: Matching files extensions

Type: array of string Default: [".md"]

MARKDOWN_RUMDL: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_FILE_EXTENSIONS MARKDOWN_RUMDL_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root MARKDOWN_RUMDL_FILE_NAMES_REGEX

MARKDOWN_RUMDL: Matching file name regexes

Type: array of string Default: []

MARKDOWN_RUMDL: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_FILE_NAMES_REGEX MARKDOWN_RUMDL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root MARKDOWN_RUMDL_FILTER_REGEX_EXCLUDE

MARKDOWN_RUMDL: Excluding Regex

Type: string

MARKDOWN_RUMDL: Custom regex excluding filter: files matching this regex will NOT be linted

root MARKDOWN_RUMDL_FILTER_REGEX_INCLUDE

MARKDOWN_RUMDL: Including Regex

Type: string

MARKDOWN_RUMDL: Custom regex including filter: only files matching this regex will be linted

root MARKDOWN_RUMDL_POST_COMMANDS

MARKDOWN_RUMDL: Post-run commands

Type: array

MARKDOWNRUMDL: Define bash commands to run after running MARKDOWNRUMDL

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_POST_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_RUMDL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_RUMDL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_RUMDL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_RUMDL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_POST_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_RUMDL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_RUMDL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_RUMDL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_RUMDL_PRE_COMMANDS

MARKDOWN_RUMDL: Pre-run commands

Type: array

MARKDOWNRUMDL: Define bash commands to run before running MARKDOWNRUMDL

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_PRE_COMMANDS Command

Command

Type: object

Command information

root MARKDOWN_RUMDL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root MARKDOWN_RUMDL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root MARKDOWN_RUMDL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root MARKDOWN_RUMDL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root MARKDOWN_RUMDL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root MARKDOWN_RUMDL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root MARKDOWN_RUMDL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root MARKDOWN_RUMDL_RULES_PATH

MARKDOWN_RUMDL: Custom config file path

Type: string

MARKDOWN_RUMDL: Path where to find linter configuration file

root MARKDOWN_RUMDL_UNSECURED_ENV_VARIABLES

MARKDOWN_RUMDL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling MARKDOWN_RUMDL and its pre/post commands

 No Additional Items

Each item of this array must be:

root MARKDOWN_RUMDL_UNSECURED_ENV_VARIABLES MARKDOWN_RUMDL_UNSECURED_ENV_VARIABLES items
Type: string

root MARKDOWN_SUMMARY_REPORTER

Activate SUMMARY reporter

Type: boolean Default: false

Generate SUMMARY reports that can be used to display issues directly in PR comment

root MARKDOWN_SUMMARY_REPORTER_FILE_NAME

SUMMARY report file name

Type: string Default: "megalinter-summary.log"

Override SUMMARY output file name

root MULTI_STATUS

(DEPRECATED) Activate GitHub Status reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBSTATUSREPORTER) Posts a status on the pull request for each processed linter

root OLLAMA_BASE_URL

OLLAMA: Base URL

Type: string Default: "http://localhost:11434"

Base URL to connect to Ollama server

root OUTPUT_DETAIL

Output detail (DEPRECATED, use reporters variables instead)

Type: enum (of string)

(DEPRECATED) Output detail for text reporter: only error files (simple) or all files (detailed)

Must be one of:

  • "simple"
  • "detailed"

root OUTPUT_FORMAT

Output format (DEPRECATED, use reporters variables instead)

Type: enum (of string)

(DEPRECATED) Output format: text or tap

Must be one of:

  • "text"
  • "tap"

root PARALLEL

Parallel processing

Type: boolean Default: true

Process linters in parallel to improve overall MegaLinter performance. If true, linters of same language or formats are grouped in the same parallel process to avoid lock issues if fixing the same files

root PARALLEL_PROCESS_NUMBER

Parallel process number

Type: number

All available cores are used by default. If there are too many, you need to decrease the number of used cores in order to enhance performances
Example:

4

root PERL_FILTER_REGEX_EXCLUDE

Excluding regex filter for PERL descriptor

Type: string

PERL: Custom regex excluding filter: files matching this regex will NOT be linted

root PERL_FILTER_REGEX_INCLUDE

Including regex filter for PERL descriptor

Type: string

PERL: Custom regex including filter: only files matching this regex will be linted

root PERL_PERLCRITIC_ARGUMENTS

PERL_PERLCRITIC: Custom arguments

Type: array of string or string

PERL_PERLCRITIC: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_ARGUMENTS PERL_PERLCRITIC_ARGUMENTS items
Type: string

root PERL_PERLCRITIC_CLI_EXECUTABLE

PERL_PERLCRITIC: CLI Executable

Type: array of string Default: [["perlcritic"]]

PERL_PERLCRITIC: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_CLI_EXECUTABLE PERL_PERLCRITIC_CLI_EXECUTABLE items
Type: string

root PERL_PERLCRITIC_CLI_LINT_MODE

PERL_PERLCRITIC: CLI lint mode

Type: enum (of string) Default: "file"

PERL_PERLCRITIC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS

PERL_PERLCRITIC: Custom remove arguments

Type: array of string or string

PERL_PERLCRITIC: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PERL_PERLCRITIC_DISABLE_ERRORS

PERL_PERLCRITIC: Disable errors

Type: boolean Default: false

PERLPERLCRITIC: If true, PERLPERLCRITIC doesn't make MegaLinter fail even if errors are found

root PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN

PERL_PERLCRITIC: Maximum number of errors allowed

Type: number Default: 0

PERLPERLCRITIC: If the number of errors found is less than this value, PERLPERLCRITIC doesn't make MegaLinter fail

root PERL_PERLCRITIC_FILE_EXTENSIONS

PERL_PERLCRITIC: Matching files extensions

Type: array of string Default: [".pl", ".pm", ".t", ""]

PERL_PERLCRITIC: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_FILE_EXTENSIONS PERL_PERLCRITIC_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PERL_PERLCRITIC_FILE_NAMES_REGEX

PERL_PERLCRITIC: Matching file name regexes

Type: array of string Default: []

PERL_PERLCRITIC: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_FILE_NAMES_REGEX PERL_PERLCRITIC_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE

PERL_PERLCRITIC: Excluding Regex

Type: string

PERL_PERLCRITIC: Custom regex excluding filter: files matching this regex will NOT be linted

root PERL_PERLCRITIC_FILTER_REGEX_INCLUDE

PERL_PERLCRITIC: Including Regex

Type: string

PERL_PERLCRITIC: Custom regex including filter: only files matching this regex will be linted

root PERL_PERLCRITIC_POST_COMMANDS

PERL_PERLCRITIC: Post-run commands

Type: array

PERLPERLCRITIC: Define bash commands to run after running PERLPERLCRITIC

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_POST_COMMANDS Command

Command

Type: object

Command information

root PERL_PERLCRITIC_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PERL_PERLCRITIC_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PERL_PERLCRITIC_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PERL_PERLCRITIC_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_POST_COMMANDS Command output_variables output_variables items
Type: string

root PERL_PERLCRITIC_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PERL_PERLCRITIC_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PERL_PERLCRITIC_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PERL_PERLCRITIC_PRE_COMMANDS

PERL_PERLCRITIC: Pre-run commands

Type: array

PERLPERLCRITIC: Define bash commands to run before running PERLPERLCRITIC

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_PRE_COMMANDS Command

Command

Type: object

Command information

root PERL_PERLCRITIC_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PERL_PERLCRITIC_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PERL_PERLCRITIC_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PERL_PERLCRITIC_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PERL_PERLCRITIC_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PERL_PERLCRITIC_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PERL_PERLCRITIC_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES

PERL_PERLCRITIC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PERL_PERLCRITIC and its pre/post commands

 No Additional Items

Each item of this array must be:

root PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES items
Type: string

root PERL_POST_COMMANDS

Post commands for PERL descriptor

Type: array

PERL: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root PERL_POST_COMMANDS Command

Command

Type: object

Command information

root PERL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PERL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PERL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PERL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PERL_POST_COMMANDS Command output_variables output_variables items
Type: string

root PERL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PERL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PERL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PERL_PRE_COMMANDS

Pre commands for PERL descriptor

Type: array

PERL: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root PERL_PRE_COMMANDS Command

Command

Type: object

Command information

root PERL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PERL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PERL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PERL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PERL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PERL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PERL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PERL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_BUILTIN_ARGUMENTS

(removed) PHP_BUILTIN: Custom arguments

Type: array of string or string

PHP_BUILTIN: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_BUILTIN_ARGUMENTS PHP_BUILTIN_ARGUMENTS items
Type: string

root PHP_BUILTIN_CLI_EXECUTABLE

(removed) PHP_BUILTIN: Override default CLI executable for linting request

Type: string

root PHP_BUILTIN_CLI_LINT_MODE

(removed) PHP_BUILTIN: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_BUILTIN_DISABLE_ERRORS

(removed) PHP_BUILTIN: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

root PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN

(removed) PHP_BUILTIN: Maximum number of errors allowed

Type: number Default: 0

root PHP_BUILTIN_FILE_EXTENSIONS

(removed) PHP_BUILTIN: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root PHP_BUILTIN_FILE_EXTENSIONS PHP_BUILTIN_FILE_EXTENSIONS items
Type: string

root PHP_BUILTIN_FILE_NAMES_REGEX

(removed) PHP_BUILTIN: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root PHP_BUILTIN_FILE_NAMES_REGEX PHP_BUILTIN_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_BUILTIN_FILTER_REGEX_EXCLUDE

(removed) PHP_BUILTIN: Excluding Regex

Type: string

root PHP_BUILTIN_FILTER_REGEX_INCLUDE

(removed) PHP_BUILTIN: Including Regex

Type: string

root PHP_BUILTIN_POST_COMMANDS

(removed) PHP_BUILTIN: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root PHP_BUILTIN_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_BUILTIN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_BUILTIN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_BUILTIN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_BUILTIN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_BUILTIN_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_BUILTIN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_BUILTIN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_BUILTIN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_BUILTIN_PRE_COMMANDS

(removed) PHP_BUILTIN: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root PHP_BUILTIN_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_BUILTIN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_BUILTIN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_BUILTIN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_BUILTIN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_BUILTIN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_BUILTIN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_BUILTIN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_BUILTIN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_FILTER_REGEX_EXCLUDE

Excluding regex filter for PHP descriptor

Type: string

PHP: Custom regex excluding filter: files matching this regex will NOT be linted

root PHP_FILTER_REGEX_INCLUDE

Including regex filter for PHP descriptor

Type: string

PHP: Custom regex including filter: only files matching this regex will be linted

root PHP_PHPCSFIXER_ARGUMENTS

PHP_PHPCSFIXER: Custom arguments

Type: array of string or string

PHP_PHPCSFIXER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_ARGUMENTS PHP_PHPCSFIXER_ARGUMENTS items
Type: string

root PHP_PHPCSFIXER_CLI_EXECUTABLE

PHP_PHPCSFIXER: CLI Executable

Type: array of string Default: [["php-cs-fixer"]]

PHP_PHPCSFIXER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_CLI_EXECUTABLE PHP_PHPCSFIXER_CLI_EXECUTABLE items
Type: string

root PHP_PHPCSFIXER_CLI_LINT_MODE

PHP_PHPCSFIXER: CLI lint mode

Type: enum (of string) Default: "project"

PHP_PHPCSFIXER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_PHPCSFIXER_COMMAND_REMOVE_ARGUMENTS

PHP_PHPCSFIXER: Custom remove arguments

Type: array of string or string

PHP_PHPCSFIXER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_COMMAND_REMOVE_ARGUMENTS PHP_PHPCSFIXER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PHP_PHPCSFIXER_CONFIG_FILE

PHP_PHPCSFIXER: Custom config file name

Type: string Default: ".php-cs-fixer.dist.php"

PHP_PHPCSFIXER: User custom config file name if different from default

root PHP_PHPCSFIXER_DISABLE_ERRORS

PHP_PHPCSFIXER: Disable errors

Type: boolean Default: false

PHPPHPCSFIXER: If true, PHPPHPCSFIXER doesn't make MegaLinter fail even if errors are found

root PHP_PHPCSFIXER_DISABLE_ERRORS_IF_LESS_THAN

PHP_PHPCSFIXER: Maximum number of errors allowed

Type: number Default: 0

PHPPHPCSFIXER: If the number of errors found is less than this value, PHPPHPCSFIXER doesn't make MegaLinter fail

root PHP_PHPCSFIXER_FILE_EXTENSIONS

PHP_PHPCSFIXER: Matching files extensions

Type: array of string Default: [".php"]

PHP_PHPCSFIXER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_FILE_EXTENSIONS PHP_PHPCSFIXER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PHP_PHPCSFIXER_FILE_NAMES_REGEX

PHP_PHPCSFIXER: Matching file name regexes

Type: array of string Default: []

PHP_PHPCSFIXER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_FILE_NAMES_REGEX PHP_PHPCSFIXER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_PHPCSFIXER_POST_COMMANDS

PHP_PHPCSFIXER: Post-run commands

Type: array

PHPPHPCSFIXER: Define bash commands to run after running PHPPHPCSFIXER

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPCSFIXER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPCSFIXER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPCSFIXER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPCSFIXER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPCSFIXER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPCSFIXER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPCSFIXER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPCSFIXER_PRE_COMMANDS

PHP_PHPCSFIXER: Pre-run commands

Type: array

PHPPHPCSFIXER: Define bash commands to run before running PHPPHPCSFIXER

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPCSFIXER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPCSFIXER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPCSFIXER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPCSFIXER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPCSFIXER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPCSFIXER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPCSFIXER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPCSFIXER_RULES_PATH

PHP_PHPCSFIXER: Custom config file path

Type: string

PHP_PHPCSFIXER: Path where to find linter configuration file

root PHP_PHPCSFIXER_UNSECURED_ENV_VARIABLES

PHP_PHPCSFIXER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PHP_PHPCSFIXER and its pre/post commands

 No Additional Items

Each item of this array must be:

root PHP_PHPCSFIXER_UNSECURED_ENV_VARIABLES PHP_PHPCSFIXER_UNSECURED_ENV_VARIABLES items
Type: string

root PHP_PHPCS_ARGUMENTS

PHP_PHPCS: Custom arguments

Type: array of string or string

PHP_PHPCS: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_ARGUMENTS PHP_PHPCS_ARGUMENTS items
Type: string

root PHP_PHPCS_CLI_EXECUTABLE

PHP_PHPCS: CLI Executable

Type: array of string Default: [["phpcs"]]

PHP_PHPCS: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_CLI_EXECUTABLE PHP_PHPCS_CLI_EXECUTABLE items
Type: string

root PHP_PHPCS_CLI_LINT_MODE

PHP_PHPCS: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PHP_PHPCS: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS

PHP_PHPCS: Custom remove arguments

Type: array of string or string

PHP_PHPCS: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PHP_PHPCS_CONFIG_FILE

PHP_PHPCS: Custom config file name

Type: string Default: "phpcs.xml"

PHP_PHPCS: User custom config file name if different from default

root PHP_PHPCS_DISABLE_ERRORS

PHP_PHPCS: Disable errors

Type: boolean Default: false

PHPPHPCS: If true, PHPPHPCS doesn't make MegaLinter fail even if errors are found

root PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN

PHP_PHPCS: Maximum number of errors allowed

Type: number Default: 0

PHPPHPCS: If the number of errors found is less than this value, PHPPHPCS doesn't make MegaLinter fail

root PHP_PHPCS_FILE_EXTENSIONS

PHP_PHPCS: Matching files extensions

Type: array of string Default: [".php"]

PHP_PHPCS: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_FILE_EXTENSIONS PHP_PHPCS_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PHP_PHPCS_FILE_NAMES_REGEX

PHP_PHPCS: Matching file name regexes

Type: array of string Default: []

PHP_PHPCS: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_FILE_NAMES_REGEX PHP_PHPCS_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_PHPCS_FILTER_REGEX_EXCLUDE

PHP_PHPCS: Excluding Regex

Type: string

PHP_PHPCS: Custom regex excluding filter: files matching this regex will NOT be linted

root PHP_PHPCS_FILTER_REGEX_INCLUDE

PHP_PHPCS: Including Regex

Type: string

PHP_PHPCS: Custom regex including filter: only files matching this regex will be linted

root PHP_PHPCS_POST_COMMANDS

PHP_PHPCS: Post-run commands

Type: array

PHPPHPCS: Define bash commands to run after running PHPPHPCS

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPCS_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPCS_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPCS_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPCS_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPCS_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPCS_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPCS_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPCS_PRE_COMMANDS

PHP_PHPCS: Pre-run commands

Type: array

PHPPHPCS: Define bash commands to run before running PHPPHPCS

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPCS_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPCS_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPCS_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPCS_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPCS_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPCS_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPCS_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPCS_RULES_PATH

PHP_PHPCS: Custom config file path

Type: string

PHP_PHPCS: Path where to find linter configuration file

root PHP_PHPCS_UNSECURED_ENV_VARIABLES

PHP_PHPCS: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PHP_PHPCS and its pre/post commands

 No Additional Items

Each item of this array must be:

root PHP_PHPCS_UNSECURED_ENV_VARIABLES PHP_PHPCS_UNSECURED_ENV_VARIABLES items
Type: string

root PHP_PHPLINT_ARGUMENTS

PHP_PHPLINT: Custom arguments

Type: array of string or string

PHP_PHPLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_ARGUMENTS PHP_PHPLINT_ARGUMENTS items
Type: string

root PHP_PHPLINT_CLI_EXECUTABLE

PHP_PHPLINT: CLI Executable

Type: array of string Default: [["phplint"]]

PHP_PHPLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_CLI_EXECUTABLE PHP_PHPLINT_CLI_EXECUTABLE items
Type: string

root PHP_PHPLINT_CLI_LINT_MODE

PHP_PHPLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PHP_PHPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS

PHP_PHPLINT: Custom remove arguments

Type: array of string or string

PHP_PHPLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PHP_PHPLINT_CONFIG_FILE

PHP_PHPLINT: Custom config file name

Type: string Default: ".phplint.yml"

PHP_PHPLINT: User custom config file name if different from default

root PHP_PHPLINT_DISABLE_ERRORS

PHP_PHPLINT: Disable errors

Type: boolean Default: false

PHPPHPLINT: If true, PHPPHPLINT doesn't make MegaLinter fail even if errors are found

root PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN

PHP_PHPLINT: Maximum number of errors allowed

Type: number Default: 0

PHPPHPLINT: If the number of errors found is less than this value, PHPPHPLINT doesn't make MegaLinter fail

root PHP_PHPLINT_FILE_EXTENSIONS

PHP_PHPLINT: Matching files extensions

Type: array of string Default: [".php"]

PHP_PHPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_FILE_EXTENSIONS PHP_PHPLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PHP_PHPLINT_FILE_NAMES_REGEX

PHP_PHPLINT: Matching file name regexes

Type: array of string Default: []

PHP_PHPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_FILE_NAMES_REGEX PHP_PHPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_PHPLINT_FILTER_REGEX_EXCLUDE

PHP_PHPLINT: Excluding Regex

Type: string

PHP_PHPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root PHP_PHPLINT_FILTER_REGEX_INCLUDE

PHP_PHPLINT: Including Regex

Type: string

PHP_PHPLINT: Custom regex including filter: only files matching this regex will be linted

root PHP_PHPLINT_POST_COMMANDS

PHP_PHPLINT: Post-run commands

Type: array

PHPPHPLINT: Define bash commands to run after running PHPPHPLINT

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPLINT_PRE_COMMANDS

PHP_PHPLINT: Pre-run commands

Type: array

PHPPHPLINT: Define bash commands to run before running PHPPHPLINT

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPLINT_RULES_PATH

PHP_PHPLINT: Custom config file path

Type: string

PHP_PHPLINT: Path where to find linter configuration file

root PHP_PHPLINT_UNSECURED_ENV_VARIABLES

PHP_PHPLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PHP_PHPLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PHP_PHPLINT_UNSECURED_ENV_VARIABLES PHP_PHPLINT_UNSECURED_ENV_VARIABLES items
Type: string

root PHP_PHPSTAN_ARGUMENTS

PHP_PHPSTAN: Custom arguments

Type: array of string or string

PHP_PHPSTAN: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_ARGUMENTS PHP_PHPSTAN_ARGUMENTS items
Type: string

root PHP_PHPSTAN_CLI_EXECUTABLE

PHP_PHPSTAN: CLI Executable

Type: array of string Default: [["phpstan"]]

PHP_PHPSTAN: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_CLI_EXECUTABLE PHP_PHPSTAN_CLI_EXECUTABLE items
Type: string

root PHP_PHPSTAN_CLI_LINT_MODE

PHP_PHPSTAN: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PHP_PHPSTAN: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS

PHP_PHPSTAN: Custom remove arguments

Type: array of string or string

PHP_PHPSTAN: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PHP_PHPSTAN_CONFIG_FILE

PHP_PHPSTAN: Custom config file name

Type: string Default: "phpstan.neon.dist"

PHP_PHPSTAN: User custom config file name if different from default

root PHP_PHPSTAN_DISABLE_ERRORS

PHP_PHPSTAN: Disable errors

Type: boolean Default: false

PHPPHPSTAN: If true, PHPPHPSTAN doesn't make MegaLinter fail even if errors are found

root PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN

PHP_PHPSTAN: Maximum number of errors allowed

Type: number Default: 0

PHPPHPSTAN: If the number of errors found is less than this value, PHPPHPSTAN doesn't make MegaLinter fail

root PHP_PHPSTAN_FILE_EXTENSIONS

PHP_PHPSTAN: Matching files extensions

Type: array of string Default: [".php"]

PHP_PHPSTAN: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_FILE_EXTENSIONS PHP_PHPSTAN_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PHP_PHPSTAN_FILE_NAMES_REGEX

PHP_PHPSTAN: Matching file name regexes

Type: array of string Default: []

PHP_PHPSTAN: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_FILE_NAMES_REGEX PHP_PHPSTAN_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_PHPSTAN_FILTER_REGEX_EXCLUDE

PHP_PHPSTAN: Excluding Regex

Type: string

PHP_PHPSTAN: Custom regex excluding filter: files matching this regex will NOT be linted

root PHP_PHPSTAN_FILTER_REGEX_INCLUDE

PHP_PHPSTAN: Including Regex

Type: string

PHP_PHPSTAN: Custom regex including filter: only files matching this regex will be linted

root PHP_PHPSTAN_POST_COMMANDS

PHP_PHPSTAN: Post-run commands

Type: array

PHPPHPSTAN: Define bash commands to run after running PHPPHPSTAN

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPSTAN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPSTAN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPSTAN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPSTAN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPSTAN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPSTAN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPSTAN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPSTAN_PRE_COMMANDS

PHP_PHPSTAN: Pre-run commands

Type: array

PHPPHPSTAN: Define bash commands to run before running PHPPHPSTAN

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PHPSTAN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PHPSTAN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PHPSTAN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PHPSTAN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PHPSTAN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PHPSTAN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PHPSTAN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PHPSTAN_RULES_PATH

PHP_PHPSTAN: Custom config file path

Type: string

PHP_PHPSTAN: Path where to find linter configuration file

root PHP_PHPSTAN_UNSECURED_ENV_VARIABLES

PHP_PHPSTAN: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PHP_PHPSTAN and its pre/post commands

 No Additional Items

Each item of this array must be:

root PHP_PHPSTAN_UNSECURED_ENV_VARIABLES PHP_PHPSTAN_UNSECURED_ENV_VARIABLES items
Type: string

root PHP_POST_COMMANDS

Post commands for PHP descriptor

Type: array

PHP: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root PHP_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PRE_COMMANDS

Pre commands for PHP descriptor

Type: array

PHP: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root PHP_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PSALM_ARGUMENTS

PHP_PSALM: Custom arguments

Type: array of string or string

PHP_PSALM: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PHP_PSALM_ARGUMENTS PHP_PSALM_ARGUMENTS items
Type: string

root PHP_PSALM_CLI_EXECUTABLE

PHP_PSALM: CLI Executable

Type: array of string Default: [["psalm"]]

PHP_PSALM: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PHP_PSALM_CLI_EXECUTABLE PHP_PSALM_CLI_EXECUTABLE items
Type: string

root PHP_PSALM_CLI_LINT_MODE

PHP_PSALM: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PHP_PSALM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PHP_PSALM_COMMAND_REMOVE_ARGUMENTS

PHP_PSALM: Custom remove arguments

Type: array of string or string

PHP_PSALM: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PHP_PSALM_COMMAND_REMOVE_ARGUMENTS PHP_PSALM_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PHP_PSALM_CONFIG_FILE

PHP_PSALM: Custom config file name

Type: string Default: "psalm.xml"

PHP_PSALM: User custom config file name if different from default

root PHP_PSALM_DISABLE_ERRORS

PHP_PSALM: Disable errors

Type: boolean Default: false

PHPPSALM: If true, PHPPSALM doesn't make MegaLinter fail even if errors are found

root PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN

PHP_PSALM: Maximum number of errors allowed

Type: number Default: 0

PHPPSALM: If the number of errors found is less than this value, PHPPSALM doesn't make MegaLinter fail

root PHP_PSALM_FILE_EXTENSIONS

PHP_PSALM: Matching files extensions

Type: array of string Default: [".php"]

PHP_PSALM: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PSALM_FILE_EXTENSIONS PHP_PSALM_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PHP_PSALM_FILE_NAMES_REGEX

PHP_PSALM: Matching file name regexes

Type: array of string Default: []

PHP_PSALM: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PHP_PSALM_FILE_NAMES_REGEX PHP_PSALM_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PHP_PSALM_FILTER_REGEX_EXCLUDE

PHP_PSALM: Excluding Regex

Type: string

PHP_PSALM: Custom regex excluding filter: files matching this regex will NOT be linted

root PHP_PSALM_FILTER_REGEX_INCLUDE

PHP_PSALM: Including Regex

Type: string

PHP_PSALM: Custom regex including filter: only files matching this regex will be linted

root PHP_PSALM_POST_COMMANDS

PHP_PSALM: Post-run commands

Type: array

PHPPSALM: Define bash commands to run after running PHPPSALM

 No Additional Items

Each item of this array must be:

root PHP_PSALM_POST_COMMANDS Command

Command

Type: object

Command information

root PHP_PSALM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PSALM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PSALM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PSALM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PSALM_POST_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PSALM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PSALM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PSALM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PSALM_PRE_COMMANDS

PHP_PSALM: Pre-run commands

Type: array

PHPPSALM: Define bash commands to run before running PHPPSALM

 No Additional Items

Each item of this array must be:

root PHP_PSALM_PRE_COMMANDS Command

Command

Type: object

Command information

root PHP_PSALM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PHP_PSALM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PHP_PSALM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PHP_PSALM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PHP_PSALM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PHP_PSALM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PHP_PSALM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PHP_PSALM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PHP_PSALM_RULES_PATH

PHP_PSALM: Custom config file path

Type: string

PHP_PSALM: Path where to find linter configuration file

root PHP_PSALM_UNSECURED_ENV_VARIABLES

PHP_PSALM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PHP_PSALM and its pre/post commands

 No Additional Items

Each item of this array must be:

root PHP_PSALM_UNSECURED_ENV_VARIABLES PHP_PSALM_UNSECURED_ENV_VARIABLES items
Type: string

root PLUGINS

List of plugins loaded at runtime

Type: array of string

List of MegaLinter plugins. URL must follow format https:///mega-linter-plugin-/**.mega-linter-descriptor.yml

 No Additional Items

Each item of this array must be:

root PLUGINS PLUGINS items
Type: string

Example:

[
    "https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml"
]

root POST_COMMANDS

Post run commands

Type: array Default: []

Custom bash commands to run after linters

 No Additional Items

Each item of this array must be:

root POST_COMMANDS Command

Command

Type: object

Command information

root POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POST_COMMANDS Command output_variables output_variables items
Type: string

root POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POST_GITHUB_COMMENT

(DEPRECATED) Activate GitHub PR Comments reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related pull request (if existing)

root POST_GITLAB_COMMENT

(DEPRECATED) Activate Gitlab MR Comments reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related merge request (if existing)

root POWERSHELL_FILTER_REGEX_EXCLUDE

Excluding regex filter for POWERSHELL descriptor

Type: string

POWERSHELL: Custom regex excluding filter: files matching this regex will NOT be linted

root POWERSHELL_FILTER_REGEX_INCLUDE

Including regex filter for POWERSHELL descriptor

Type: string

POWERSHELL: Custom regex including filter: only files matching this regex will be linted

root POWERSHELL_POST_COMMANDS

Post commands for POWERSHELL descriptor

Type: array

POWERSHELL: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root POWERSHELL_POST_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POWERSHELL_POWERSHELL_ARGUMENTS

POWERSHELL_POWERSHELL: Custom arguments

Type: array of string or string

POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_ARGUMENTS POWERSHELL_POWERSHELL_ARGUMENTS items
Type: string

root POWERSHELL_POWERSHELL_CLI_EXECUTABLE

POWERSHELL_POWERSHELL: CLI Executable

Type: array of string Default: [["powershell"]]

POWERSHELL_POWERSHELL: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_CLI_EXECUTABLE POWERSHELL_POWERSHELL_CLI_EXECUTABLE items
Type: string

root POWERSHELL_POWERSHELL_CLI_LINT_MODE

POWERSHELL_POWERSHELL: CLI lint mode

Type: enum (of string) Default: "file"

POWERSHELL_POWERSHELL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS

POWERSHELL_POWERSHELL: Custom remove arguments

Type: array of string or string

POWERSHELL_POWERSHELL: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS items
Type: string

root POWERSHELL_POWERSHELL_CONFIG_FILE

POWERSHELL_POWERSHELL: Custom config file name

Type: string Default: ".powershell-psscriptanalyzer.psd1"

POWERSHELL_POWERSHELL: User custom config file name if different from default

root POWERSHELL_POWERSHELL_DISABLE_ERRORS

POWERSHELL_POWERSHELL: Disable errors

Type: boolean Default: false

POWERSHELLPOWERSHELL: If true, POWERSHELLPOWERSHELL doesn't make MegaLinter fail even if errors are found

root POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN

POWERSHELL_POWERSHELL: Maximum number of errors allowed

Type: number Default: 0

POWERSHELLPOWERSHELL: If the number of errors found is less than this value, POWERSHELLPOWERSHELL doesn't make MegaLinter fail

root POWERSHELL_POWERSHELL_FILE_EXTENSIONS

POWERSHELL_POWERSHELL: Matching files extensions

Type: array of string Default: [".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]

POWERSHELL_POWERSHELL: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FILE_EXTENSIONS POWERSHELL_POWERSHELL_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root POWERSHELL_POWERSHELL_FILE_NAMES_REGEX

POWERSHELL_POWERSHELL: Matching file name regexes

Type: array of string Default: []

POWERSHELL_POWERSHELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FILE_NAMES_REGEX POWERSHELL_POWERSHELL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE

POWERSHELL_POWERSHELL: Excluding Regex

Type: string

POWERSHELL_POWERSHELL: Custom regex excluding filter: files matching this regex will NOT be linted

root POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE

POWERSHELL_POWERSHELL: Including Regex

Type: string

POWERSHELL_POWERSHELL: Custom regex including filter: only files matching this regex will be linted

root POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS

POWERSHELL_POWERSHELL_FORMATTER: Custom arguments

Type: array of string or string

POWERSHELLPOWERSHELLFORMATTER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS items
Type: string

root POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE

POWERSHELL_POWERSHELL_FORMATTER: CLI Executable

Type: array of string Default: [["powershell"]]

POWERSHELLPOWERSHELLFORMATTER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE items
Type: string

root POWERSHELL_POWERSHELL_FORMATTER_CLI_LINT_MODE

POWERSHELL_POWERSHELL_FORMATTER: CLI lint mode

Type: enum (of string) Default: "file"

POWERSHELLPOWERSHELLFORMATTER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS

POWERSHELL_POWERSHELL_FORMATTER: Custom remove arguments

Type: array of string or string

POWERSHELLPOWERSHELLFORMATTER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root POWERSHELL_POWERSHELL_FORMATTER_CONFIG_FILE

POWERSHELL_POWERSHELL_FORMATTER: Custom config file name

Type: string Default: ".powershell-formatter.psd1"

POWERSHELLPOWERSHELLFORMATTER: User custom config file name if different from default

root POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS

POWERSHELL_POWERSHELL_FORMATTER: Disable errors

Type: boolean Default: false

POWERSHELLPOWERSHELLFORMATTER: If true, POWERSHELLPOWERSHELLFORMATTER doesn't make MegaLinter fail even if errors are found

root POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN

POWERSHELL_POWERSHELL_FORMATTER: Maximum number of errors allowed

Type: number Default: 0

POWERSHELLPOWERSHELLFORMATTER: If the number of errors found is less than this value, POWERSHELLPOWERSHELLFORMATTER doesn't make MegaLinter fail

root POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS

POWERSHELL_POWERSHELL_FORMATTER: Matching files extensions

Type: array of string Default: [".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]

POWERSHELLPOWERSHELLFORMATTER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX

POWERSHELL_POWERSHELL_FORMATTER: Matching file name regexes

Type: array of string Default: []

POWERSHELLPOWERSHELLFORMATTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_EXCLUDE

POWERSHELL_POWERSHELL_FORMATTER: Excluding Regex

Type: string

POWERSHELLPOWERSHELLFORMATTER: Custom regex excluding filter: files matching this regex will NOT be linted

root POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_INCLUDE

POWERSHELL_POWERSHELL_FORMATTER: Including Regex

Type: string

POWERSHELLPOWERSHELLFORMATTER: Custom regex including filter: only files matching this regex will be linted

root POWERSHELL_POWERSHELL_FORMATTER_OUTPUT_ENCODING

POWERSHELL_POWERSHELL_FORMATTER: Output encoding type

Type: string Default: "utf8"

POWERSHELLPOWERSHELLFORMATTER: -Encoding to be used when writing content to the file

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS

POWERSHELL_POWERSHELL_FORMATTER: Post-run commands

Type: array

POWERSHELLPOWERSHELLFORMATTER: Define bash commands to run after running POWERSHELLPOWERSHELLFORMATTER

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS

POWERSHELL_POWERSHELL_FORMATTER: Pre-run commands

Type: array

POWERSHELLPOWERSHELLFORMATTER: Define bash commands to run before running POWERSHELLPOWERSHELLFORMATTER

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH

POWERSHELL_POWERSHELL_FORMATTER: Custom config file path

Type: string

POWERSHELLPOWERSHELLFORMATTER: Path where to find linter configuration file

root POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES

POWERSHELL_POWERSHELL_FORMATTER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling POWERSHELLPOWERSHELLFORMATTER and its pre/post commands

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES items
Type: string

root POWERSHELL_POWERSHELL_POST_COMMANDS

POWERSHELL_POWERSHELL: Post-run commands

Type: array

POWERSHELLPOWERSHELL: Define bash commands to run after running POWERSHELLPOWERSHELL

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_POST_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_POWERSHELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_POWERSHELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_POWERSHELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_POWERSHELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_POWERSHELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_POWERSHELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_POWERSHELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POWERSHELL_POWERSHELL_PRE_COMMANDS

POWERSHELL_POWERSHELL: Pre-run commands

Type: array

POWERSHELLPOWERSHELL: Define bash commands to run before running POWERSHELLPOWERSHELL

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_POWERSHELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root POWERSHELL_POWERSHELL_RULES_PATH

POWERSHELL_POWERSHELL: Custom config file path

Type: string

POWERSHELL_POWERSHELL: Path where to find linter configuration file

root POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES

POWERSHELL_POWERSHELL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL and its pre/post commands

 No Additional Items

Each item of this array must be:

root POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES items
Type: string

root POWERSHELL_PRE_COMMANDS

Pre commands for POWERSHELL descriptor

Type: array

POWERSHELL: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root POWERSHELL_PRE_COMMANDS Command

Command

Type: object

Command information

root POWERSHELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root POWERSHELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root POWERSHELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root POWERSHELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root POWERSHELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root POWERSHELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root POWERSHELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root POWERSHELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PRE_COMMANDS

Pre-run commands

Type: array Default: []

Custom bash commands to run before linters

 No Additional Items

Each item of this array must be:

root PRE_COMMANDS Command

Command

Type: object

Command information

root PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PRE_COMMANDS Command output_variables output_variables items
Type: string

root PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm install java-caller",
        "continue_if_failed": false,
        "cwd": "root"
    },
    {
        "command": "echo \"pre-run command has been called\"",
        "cwd": "workspace"
    }
]

root PROTOBUF_FILTER_REGEX_EXCLUDE

Excluding regex filter for PROTOBUF descriptor

Type: string

PROTOBUF: Custom regex excluding filter: files matching this regex will NOT be linted

root PROTOBUF_FILTER_REGEX_INCLUDE

Including regex filter for PROTOBUF descriptor

Type: string

PROTOBUF: Custom regex including filter: only files matching this regex will be linted

root PROTOBUF_POST_COMMANDS

Post commands for PROTOBUF descriptor

Type: array

PROTOBUF: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root PROTOBUF_POST_COMMANDS Command

Command

Type: object

Command information

root PROTOBUF_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PROTOBUF_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PROTOBUF_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PROTOBUF_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PROTOBUF_POST_COMMANDS Command output_variables output_variables items
Type: string

root PROTOBUF_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PROTOBUF_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PROTOBUF_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PROTOBUF_PRE_COMMANDS

Pre commands for PROTOBUF descriptor

Type: array

PROTOBUF: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root PROTOBUF_PRE_COMMANDS Command

Command

Type: object

Command information

root PROTOBUF_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PROTOBUF_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PROTOBUF_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PROTOBUF_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PROTOBUF_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PROTOBUF_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PROTOBUF_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PROTOBUF_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PROTOBUF_PROTOLINT_ARGUMENTS

PROTOBUF_PROTOLINT: Custom arguments

Type: array of string or string

PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_ARGUMENTS PROTOBUF_PROTOLINT_ARGUMENTS items
Type: string

root PROTOBUF_PROTOLINT_CLI_EXECUTABLE

PROTOBUF_PROTOLINT: CLI Executable

Type: array of string Default: [["protolint"]]

PROTOBUF_PROTOLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_CLI_EXECUTABLE PROTOBUF_PROTOLINT_CLI_EXECUTABLE items
Type: string

root PROTOBUF_PROTOLINT_CLI_LINT_MODE

PROTOBUF_PROTOLINT: CLI lint mode

Type: enum (of string) Default: "file"

PROTOBUF_PROTOLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS

PROTOBUF_PROTOLINT: Custom remove arguments

Type: array of string or string

PROTOBUF_PROTOLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PROTOBUF_PROTOLINT_CONFIG_FILE

PROTOBUF_PROTOLINT: Custom config file name

Type: string Default: ".protolintrc.yml"

PROTOBUF_PROTOLINT: User custom config file name if different from default

root PROTOBUF_PROTOLINT_DISABLE_ERRORS

PROTOBUF_PROTOLINT: Disable errors

Type: boolean Default: false

PROTOBUFPROTOLINT: If true, PROTOBUFPROTOLINT doesn't make MegaLinter fail even if errors are found

root PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN

PROTOBUF_PROTOLINT: Maximum number of errors allowed

Type: number Default: 0

PROTOBUFPROTOLINT: If the number of errors found is less than this value, PROTOBUFPROTOLINT doesn't make MegaLinter fail

root PROTOBUF_PROTOLINT_FILE_EXTENSIONS

PROTOBUF_PROTOLINT: Matching files extensions

Type: array of string Default: [".proto"]

PROTOBUF_PROTOLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_FILE_EXTENSIONS PROTOBUF_PROTOLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PROTOBUF_PROTOLINT_FILE_NAMES_REGEX

PROTOBUF_PROTOLINT: Matching file name regexes

Type: array of string Default: []

PROTOBUF_PROTOLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_FILE_NAMES_REGEX PROTOBUF_PROTOLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE

PROTOBUF_PROTOLINT: Excluding Regex

Type: string

PROTOBUF_PROTOLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE

PROTOBUF_PROTOLINT: Including Regex

Type: string

PROTOBUF_PROTOLINT: Custom regex including filter: only files matching this regex will be linted

root PROTOBUF_PROTOLINT_POST_COMMANDS

PROTOBUF_PROTOLINT: Post-run commands

Type: array

PROTOBUFPROTOLINT: Define bash commands to run after running PROTOBUFPROTOLINT

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_POST_COMMANDS Command

Command

Type: object

Command information

root PROTOBUF_PROTOLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PROTOBUF_PROTOLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PROTOBUF_PROTOLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PROTOBUF_PROTOLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PROTOBUF_PROTOLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PROTOBUF_PROTOLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PROTOBUF_PROTOLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PROTOBUF_PROTOLINT_PRE_COMMANDS

PROTOBUF_PROTOLINT: Pre-run commands

Type: array

PROTOBUFPROTOLINT: Define bash commands to run before running PROTOBUFPROTOLINT

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PROTOBUF_PROTOLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PROTOBUF_PROTOLINT_RULES_PATH

PROTOBUF_PROTOLINT: Custom config file path

Type: string

PROTOBUF_PROTOLINT: Path where to find linter configuration file

root PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES

PROTOBUF_PROTOLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PROTOBUF_PROTOLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES items
Type: string

root PUPPET_FILTER_REGEX_EXCLUDE

Excluding regex filter for PUPPET descriptor

Type: string

PUPPET: Custom regex excluding filter: files matching this regex will NOT be linted

root PUPPET_FILTER_REGEX_INCLUDE

Including regex filter for PUPPET descriptor

Type: string

PUPPET: Custom regex including filter: only files matching this regex will be linted

root PUPPET_POST_COMMANDS

Post commands for PUPPET descriptor

Type: array

PUPPET: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root PUPPET_POST_COMMANDS Command

Command

Type: object

Command information

root PUPPET_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PUPPET_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PUPPET_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PUPPET_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PUPPET_POST_COMMANDS Command output_variables output_variables items
Type: string

root PUPPET_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PUPPET_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PUPPET_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PUPPET_PRE_COMMANDS

Pre commands for PUPPET descriptor

Type: array

PUPPET: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root PUPPET_PRE_COMMANDS Command

Command

Type: object

Command information

root PUPPET_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PUPPET_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PUPPET_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PUPPET_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PUPPET_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PUPPET_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PUPPET_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PUPPET_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PUPPET_PUPPET_LINT_ARGUMENTS

PUPPET_PUPPET_LINT: Custom arguments

Type: array of string or string

PUPPETPUPPETLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_ARGUMENTS PUPPET_PUPPET_LINT_ARGUMENTS items
Type: string

root PUPPET_PUPPET_LINT_CLI_EXECUTABLE

PUPPET_PUPPET_LINT: CLI Executable

Type: array of string Default: [["puppet-lint"]]

PUPPETPUPPETLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_CLI_EXECUTABLE PUPPET_PUPPET_LINT_CLI_EXECUTABLE items
Type: string

root PUPPET_PUPPET_LINT_CLI_LINT_MODE

PUPPET_PUPPET_LINT: CLI lint mode

Type: enum (of string) Default: "file"

PUPPETPUPPETLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS

PUPPET_PUPPET_LINT: Custom remove arguments

Type: array of string or string

PUPPETPUPPETLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PUPPET_PUPPET_LINT_CONFIG_FILE

PUPPET_PUPPET_LINT: Custom config file name

Type: string Default: ".puppet-lint.rc"

PUPPETPUPPETLINT: User custom config file name if different from default

root PUPPET_PUPPET_LINT_DISABLE_ERRORS

PUPPET_PUPPET_LINT: Disable errors

Type: boolean Default: false

PUPPETPUPPETLINT: If true, PUPPETPUPPETLINT doesn't make MegaLinter fail even if errors are found

root PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN

PUPPET_PUPPET_LINT: Maximum number of errors allowed

Type: number Default: 0

PUPPETPUPPETLINT: If the number of errors found is less than this value, PUPPETPUPPETLINT doesn't make MegaLinter fail

root PUPPET_PUPPET_LINT_FILE_EXTENSIONS

PUPPET_PUPPET_LINT: Matching files extensions

Type: array of string Default: [".pp"]

PUPPETPUPPETLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_FILE_EXTENSIONS PUPPET_PUPPET_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PUPPET_PUPPET_LINT_FILE_NAMES_REGEX

PUPPET_PUPPET_LINT: Matching file name regexes

Type: array of string Default: []

PUPPETPUPPETLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_FILE_NAMES_REGEX PUPPET_PUPPET_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE

PUPPET_PUPPET_LINT: Excluding Regex

Type: string

PUPPETPUPPETLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE

PUPPET_PUPPET_LINT: Including Regex

Type: string

PUPPETPUPPETLINT: Custom regex including filter: only files matching this regex will be linted

root PUPPET_PUPPET_LINT_POST_COMMANDS

PUPPET_PUPPET_LINT: Post-run commands

Type: array

PUPPETPUPPETLINT: Define bash commands to run after running PUPPETPUPPETLINT

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root PUPPET_PUPPET_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PUPPET_PUPPET_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PUPPET_PUPPET_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PUPPET_PUPPET_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PUPPET_PUPPET_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PUPPET_PUPPET_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PUPPET_PUPPET_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PUPPET_PUPPET_LINT_PRE_COMMANDS

PUPPET_PUPPET_LINT: Pre-run commands

Type: array

PUPPETPUPPETLINT: Define bash commands to run before running PUPPETPUPPETLINT

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PUPPET_PUPPET_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PUPPET_PUPPET_LINT_RULES_PATH

PUPPET_PUPPET_LINT: Custom config file path

Type: string

PUPPETPUPPETLINT: Path where to find linter configuration file

root PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES

PUPPET_PUPPET_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PUPPETPUPPETLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_BANDIT_ARGUMENTS

PYTHON_BANDIT: Custom arguments

Type: array of string or string

PYTHON_BANDIT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_ARGUMENTS PYTHON_BANDIT_ARGUMENTS items
Type: string

root PYTHON_BANDIT_CLI_EXECUTABLE

PYTHON_BANDIT: CLI Executable

Type: array of string Default: [["bandit"]]

PYTHON_BANDIT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_CLI_EXECUTABLE PYTHON_BANDIT_CLI_EXECUTABLE items
Type: string

root PYTHON_BANDIT_CLI_LINT_MODE

PYTHON_BANDIT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_BANDIT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS

PYTHON_BANDIT: Custom remove arguments

Type: array of string or string

PYTHON_BANDIT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_BANDIT_CONFIG_FILE

PYTHON_BANDIT: Custom config file name

Type: string Default: ".bandit.yml"

PYTHON_BANDIT: User custom config file name if different from default

root PYTHON_BANDIT_DISABLE_ERRORS

PYTHON_BANDIT: Disable errors

Type: boolean Default: false

PYTHONBANDIT: If true, PYTHONBANDIT doesn't make MegaLinter fail even if errors are found

root PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_BANDIT: Maximum number of errors allowed

Type: number Default: 0

PYTHONBANDIT: If the number of errors found is less than this value, PYTHONBANDIT doesn't make MegaLinter fail

root PYTHON_BANDIT_FILE_EXTENSIONS

PYTHON_BANDIT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_BANDIT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_FILE_EXTENSIONS PYTHON_BANDIT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_BANDIT_FILE_NAMES_REGEX

PYTHON_BANDIT: Matching file name regexes

Type: array of string Default: []

PYTHON_BANDIT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_FILE_NAMES_REGEX PYTHON_BANDIT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_BANDIT_FILTER_REGEX_EXCLUDE

PYTHON_BANDIT: Excluding Regex

Type: string

PYTHON_BANDIT: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_BANDIT_FILTER_REGEX_INCLUDE

PYTHON_BANDIT: Including Regex

Type: string

PYTHON_BANDIT: Custom regex including filter: only files matching this regex will be linted

root PYTHON_BANDIT_POST_COMMANDS

PYTHON_BANDIT: Post-run commands

Type: array

PYTHONBANDIT: Define bash commands to run after running PYTHONBANDIT

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_BANDIT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_BANDIT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_BANDIT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_BANDIT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_BANDIT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_BANDIT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_BANDIT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_BANDIT_PRE_COMMANDS

PYTHON_BANDIT: Pre-run commands

Type: array

PYTHONBANDIT: Define bash commands to run before running PYTHONBANDIT

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_BANDIT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_BANDIT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_BANDIT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_BANDIT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_BANDIT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_BANDIT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_BANDIT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_BANDIT_RULES_PATH

PYTHON_BANDIT: Custom config file path

Type: string

PYTHON_BANDIT: Path where to find linter configuration file

root PYTHON_BANDIT_UNSECURED_ENV_VARIABLES

PYTHON_BANDIT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_BANDIT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_BANDIT_UNSECURED_ENV_VARIABLES PYTHON_BANDIT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_BLACK_ARGUMENTS

PYTHON_BLACK: Custom arguments

Type: array of string or string

PYTHON_BLACK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_ARGUMENTS PYTHON_BLACK_ARGUMENTS items
Type: string

root PYTHON_BLACK_CLI_EXECUTABLE

PYTHON_BLACK: CLI Executable

Type: array of string Default: [["black"]]

PYTHON_BLACK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_CLI_EXECUTABLE PYTHON_BLACK_CLI_EXECUTABLE items
Type: string

root PYTHON_BLACK_CLI_LINT_MODE

PYTHON_BLACK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_BLACK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS

PYTHON_BLACK: Custom remove arguments

Type: array of string or string

PYTHON_BLACK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_BLACK_CONFIG_FILE

PYTHON_BLACK: Custom config file name

Type: string Default: "pyproject.toml"

PYTHON_BLACK: User custom config file name if different from default

root PYTHON_BLACK_DISABLE_ERRORS

PYTHON_BLACK: Disable errors

Type: boolean Default: false

PYTHONBLACK: If true, PYTHONBLACK doesn't make MegaLinter fail even if errors are found

root PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_BLACK: Maximum number of errors allowed

Type: number Default: 0

PYTHONBLACK: If the number of errors found is less than this value, PYTHONBLACK doesn't make MegaLinter fail

root PYTHON_BLACK_FILE_EXTENSIONS

PYTHON_BLACK: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_BLACK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_FILE_EXTENSIONS PYTHON_BLACK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_BLACK_FILE_NAMES_REGEX

PYTHON_BLACK: Matching file name regexes

Type: array of string Default: []

PYTHON_BLACK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_FILE_NAMES_REGEX PYTHON_BLACK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_BLACK_FILTER_REGEX_EXCLUDE

PYTHON_BLACK: Excluding Regex

Type: string

PYTHON_BLACK: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_BLACK_FILTER_REGEX_INCLUDE

PYTHON_BLACK: Including Regex

Type: string

PYTHON_BLACK: Custom regex including filter: only files matching this regex will be linted

root PYTHON_BLACK_POST_COMMANDS

PYTHON_BLACK: Post-run commands

Type: array

PYTHONBLACK: Define bash commands to run after running PYTHONBLACK

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_BLACK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_BLACK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_BLACK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_BLACK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_BLACK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_BLACK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_BLACK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_BLACK_PRE_COMMANDS

PYTHON_BLACK: Pre-run commands

Type: array

PYTHONBLACK: Define bash commands to run before running PYTHONBLACK

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_BLACK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_BLACK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_BLACK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_BLACK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_BLACK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_BLACK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_BLACK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_BLACK_RULES_PATH

PYTHON_BLACK: Custom config file path

Type: string

PYTHON_BLACK: Path where to find linter configuration file

root PYTHON_BLACK_UNSECURED_ENV_VARIABLES

PYTHON_BLACK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_BLACK and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_BLACK_UNSECURED_ENV_VARIABLES PYTHON_BLACK_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_DEFAULT_STYLE

Python default style

Type: enum (of string) Default: "black"

Style of python formatting to apply

Must be one of:

  • "black"
  • "ruff"

Examples:

"black"

"ruff"

root PYTHON_FILTER_REGEX_EXCLUDE

Excluding regex filter for PYTHON descriptor

Type: string

PYTHON: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_FILTER_REGEX_INCLUDE

Including regex filter for PYTHON descriptor

Type: string

PYTHON: Custom regex including filter: only files matching this regex will be linted

root PYTHON_FLAKE8_ARGUMENTS

PYTHON_FLAKE8: Custom arguments

Type: array of string or string

PYTHON_FLAKE8: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_ARGUMENTS PYTHON_FLAKE8_ARGUMENTS items
Type: string

root PYTHON_FLAKE8_CLI_EXECUTABLE

PYTHON_FLAKE8: CLI Executable

Type: array of string Default: [["flake8"]]

PYTHON_FLAKE8: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_CLI_EXECUTABLE PYTHON_FLAKE8_CLI_EXECUTABLE items
Type: string

root PYTHON_FLAKE8_CLI_LINT_MODE

PYTHON_FLAKE8: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_FLAKE8: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS

PYTHON_FLAKE8: Custom remove arguments

Type: array of string or string

PYTHON_FLAKE8: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_FLAKE8_CONFIG_FILE

PYTHON_FLAKE8: Custom config file name

Type: string Default: ".flake8"

PYTHON_FLAKE8: User custom config file name if different from default

root PYTHON_FLAKE8_DISABLE_ERRORS

PYTHON_FLAKE8: Disable errors

Type: boolean Default: false

PYTHONFLAKE8: If true, PYTHONFLAKE8 doesn't make MegaLinter fail even if errors are found

root PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_FLAKE8: Maximum number of errors allowed

Type: number Default: 0

PYTHONFLAKE8: If the number of errors found is less than this value, PYTHONFLAKE8 doesn't make MegaLinter fail

root PYTHON_FLAKE8_FILE_EXTENSIONS

PYTHON_FLAKE8: Matching files extensions

Type: array of string Default: [".py"]

PYTHON_FLAKE8: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_FILE_EXTENSIONS PYTHON_FLAKE8_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_FLAKE8_FILE_NAMES_REGEX

PYTHON_FLAKE8: Matching file name regexes

Type: array of string Default: []

PYTHON_FLAKE8: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_FILE_NAMES_REGEX PYTHON_FLAKE8_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE

PYTHON_FLAKE8: Excluding Regex

Type: string

PYTHON_FLAKE8: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_FLAKE8_FILTER_REGEX_INCLUDE

PYTHON_FLAKE8: Including Regex

Type: string

PYTHON_FLAKE8: Custom regex including filter: only files matching this regex will be linted

root PYTHON_FLAKE8_POST_COMMANDS

PYTHON_FLAKE8: Post-run commands

Type: array

PYTHONFLAKE8: Define bash commands to run after running PYTHONFLAKE8

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_FLAKE8_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_FLAKE8_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_FLAKE8_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_FLAKE8_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_FLAKE8_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_FLAKE8_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_FLAKE8_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_FLAKE8_PRE_COMMANDS

PYTHON_FLAKE8: Pre-run commands

Type: array

PYTHONFLAKE8: Define bash commands to run before running PYTHONFLAKE8

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_FLAKE8_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_FLAKE8_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_FLAKE8_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_FLAKE8_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_FLAKE8_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_FLAKE8_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_FLAKE8_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_FLAKE8_RULES_PATH

PYTHON_FLAKE8: Custom config file path

Type: string

PYTHON_FLAKE8: Path where to find linter configuration file

root PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES

PYTHON_FLAKE8: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_FLAKE8 and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_ISORT_ARGUMENTS

PYTHON_ISORT: Custom arguments

Type: array of string or string

PYTHON_ISORT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_ARGUMENTS PYTHON_ISORT_ARGUMENTS items
Type: string

root PYTHON_ISORT_CLI_EXECUTABLE

PYTHON_ISORT: CLI Executable

Type: array of string Default: [["isort"]]

PYTHON_ISORT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_CLI_EXECUTABLE PYTHON_ISORT_CLI_EXECUTABLE items
Type: string

root PYTHON_ISORT_CLI_LINT_MODE

PYTHON_ISORT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_ISORT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS

PYTHON_ISORT: Custom remove arguments

Type: array of string or string

PYTHON_ISORT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_ISORT_CONFIG_FILE

PYTHON_ISORT: Custom config file name

Type: string Default: ".isort.cfg"

PYTHON_ISORT: User custom config file name if different from default

root PYTHON_ISORT_DISABLE_ERRORS

PYTHON_ISORT: Disable errors

Type: boolean Default: false

PYTHONISORT: If true, PYTHONISORT doesn't make MegaLinter fail even if errors are found

root PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_ISORT: Maximum number of errors allowed

Type: number Default: 0

PYTHONISORT: If the number of errors found is less than this value, PYTHONISORT doesn't make MegaLinter fail

root PYTHON_ISORT_FILE_EXTENSIONS

PYTHON_ISORT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".pyx", ".pxd"]

PYTHON_ISORT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_FILE_EXTENSIONS PYTHON_ISORT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_ISORT_FILE_NAMES_REGEX

PYTHON_ISORT: Matching file name regexes

Type: array of string Default: []

PYTHON_ISORT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_FILE_NAMES_REGEX PYTHON_ISORT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_ISORT_FILTER_REGEX_EXCLUDE

PYTHON_ISORT: Excluding Regex

Type: string

PYTHON_ISORT: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_ISORT_FILTER_REGEX_INCLUDE

PYTHON_ISORT: Including Regex

Type: string

PYTHON_ISORT: Custom regex including filter: only files matching this regex will be linted

root PYTHON_ISORT_POST_COMMANDS

PYTHON_ISORT: Post-run commands

Type: array

PYTHONISORT: Define bash commands to run after running PYTHONISORT

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_ISORT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_ISORT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_ISORT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_ISORT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_ISORT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_ISORT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_ISORT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_ISORT_PRE_COMMANDS

PYTHON_ISORT: Pre-run commands

Type: array

PYTHONISORT: Define bash commands to run before running PYTHONISORT

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_ISORT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_ISORT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_ISORT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_ISORT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_ISORT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_ISORT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_ISORT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_ISORT_RULES_PATH

PYTHON_ISORT: Custom config file path

Type: string

PYTHON_ISORT: Path where to find linter configuration file

root PYTHON_ISORT_UNSECURED_ENV_VARIABLES

PYTHON_ISORT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_ISORT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_ISORT_UNSECURED_ENV_VARIABLES PYTHON_ISORT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_MYPY_ARGUMENTS

PYTHON_MYPY: Custom arguments

Type: array of string or string

PYTHON_MYPY: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_ARGUMENTS PYTHON_MYPY_ARGUMENTS items
Type: string

root PYTHON_MYPY_CLI_EXECUTABLE

PYTHON_MYPY: CLI Executable

Type: array of string Default: [["mypy"]]

PYTHON_MYPY: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_CLI_EXECUTABLE PYTHON_MYPY_CLI_EXECUTABLE items
Type: string

root PYTHON_MYPY_CLI_LINT_MODE

PYTHON_MYPY: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_MYPY: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS

PYTHON_MYPY: Custom remove arguments

Type: array of string or string

PYTHON_MYPY: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_MYPY_CONFIG_FILE

PYTHON_MYPY: Custom config file name

Type: string Default: ".mypy.ini"

PYTHON_MYPY: User custom config file name if different from default

root PYTHON_MYPY_DISABLE_ERRORS

PYTHON_MYPY: Disable errors

Type: boolean Default: false

PYTHONMYPY: If true, PYTHONMYPY doesn't make MegaLinter fail even if errors are found

root PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_MYPY: Maximum number of errors allowed

Type: number Default: 0

PYTHONMYPY: If the number of errors found is less than this value, PYTHONMYPY doesn't make MegaLinter fail

root PYTHON_MYPY_FILE_EXTENSIONS

PYTHON_MYPY: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_MYPY: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_FILE_EXTENSIONS PYTHON_MYPY_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_MYPY_FILE_NAMES_REGEX

PYTHON_MYPY: Matching file name regexes

Type: array of string Default: []

PYTHON_MYPY: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_FILE_NAMES_REGEX PYTHON_MYPY_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_MYPY_FILTER_REGEX_EXCLUDE

PYTHON_MYPY: Excluding Regex

Type: string

PYTHON_MYPY: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_MYPY_FILTER_REGEX_INCLUDE

PYTHON_MYPY: Including Regex

Type: string

PYTHON_MYPY: Custom regex including filter: only files matching this regex will be linted

root PYTHON_MYPY_POST_COMMANDS

PYTHON_MYPY: Post-run commands

Type: array

PYTHONMYPY: Define bash commands to run after running PYTHONMYPY

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_MYPY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_MYPY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_MYPY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_MYPY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_MYPY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_MYPY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_MYPY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_MYPY_PRE_COMMANDS

PYTHON_MYPY: Pre-run commands

Type: array

PYTHONMYPY: Define bash commands to run before running PYTHONMYPY

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_MYPY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_MYPY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_MYPY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_MYPY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_MYPY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_MYPY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_MYPY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_MYPY_RULES_PATH

PYTHON_MYPY: Custom config file path

Type: string

PYTHON_MYPY: Path where to find linter configuration file

root PYTHON_MYPY_UNSECURED_ENV_VARIABLES

PYTHON_MYPY: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_MYPY and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_MYPY_UNSECURED_ENV_VARIABLES PYTHON_MYPY_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_POST_COMMANDS

Post commands for PYTHON descriptor

Type: array

PYTHON: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root PYTHON_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PRE_COMMANDS

Pre commands for PYTHON descriptor

Type: array

PYTHON: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root PYTHON_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PYLINT_ARGUMENTS

PYTHON_PYLINT: Custom arguments

Type: array of string or string

PYTHON_PYLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_ARGUMENTS PYTHON_PYLINT_ARGUMENTS items
Type: string

root PYTHON_PYLINT_CLI_EXECUTABLE

PYTHON_PYLINT: CLI Executable

Type: array of string Default: [["pylint"]]

PYTHON_PYLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_CLI_EXECUTABLE PYTHON_PYLINT_CLI_EXECUTABLE items
Type: string

root PYTHON_PYLINT_CLI_LINT_MODE

PYTHON_PYLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_PYLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS

PYTHON_PYLINT: Custom remove arguments

Type: array of string or string

PYTHON_PYLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_PYLINT_CONFIG_FILE

PYTHON_PYLINT: Custom config file name

Type: string Default: ".pylintrc"

PYTHON_PYLINT: User custom config file name if different from default

root PYTHON_PYLINT_DISABLE_ERRORS

PYTHON_PYLINT: Disable errors

Type: boolean Default: false

PYTHONPYLINT: If true, PYTHONPYLINT doesn't make MegaLinter fail even if errors are found

root PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_PYLINT: Maximum number of errors allowed

Type: number Default: 0

PYTHONPYLINT: If the number of errors found is less than this value, PYTHONPYLINT doesn't make MegaLinter fail

root PYTHON_PYLINT_FILE_EXTENSIONS

PYTHON_PYLINT: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_PYLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_FILE_EXTENSIONS PYTHON_PYLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_PYLINT_FILE_NAMES_REGEX

PYTHON_PYLINT: Matching file name regexes

Type: array of string Default: []

PYTHON_PYLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_FILE_NAMES_REGEX PYTHON_PYLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_PYLINT_FILTER_REGEX_EXCLUDE

PYTHON_PYLINT: Excluding Regex

Type: string

PYTHON_PYLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_PYLINT_FILTER_REGEX_INCLUDE

PYTHON_PYLINT: Including Regex

Type: string

PYTHON_PYLINT: Custom regex including filter: only files matching this regex will be linted

root PYTHON_PYLINT_POST_COMMANDS

PYTHON_PYLINT: Post-run commands

Type: array

PYTHONPYLINT: Define bash commands to run after running PYTHONPYLINT

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_PYLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_PYLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_PYLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_PYLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_PYLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_PYLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_PYLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PYLINT_PRE_COMMANDS

PYTHON_PYLINT: Pre-run commands

Type: array

PYTHONPYLINT: Define bash commands to run before running PYTHONPYLINT

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_PYLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_PYLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_PYLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_PYLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_PYLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_PYLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_PYLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PYLINT_RULES_PATH

PYTHON_PYLINT: Custom config file path

Type: string

PYTHON_PYLINT: Path where to find linter configuration file

root PYTHON_PYLINT_UNSECURED_ENV_VARIABLES

PYTHON_PYLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_PYLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_PYLINT_UNSECURED_ENV_VARIABLES PYTHON_PYLINT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_PYRIGHT_ARGUMENTS

PYTHON_PYRIGHT: Custom arguments

Type: array of string or string

PYTHON_PYRIGHT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_ARGUMENTS PYTHON_PYRIGHT_ARGUMENTS items
Type: string

root PYTHON_PYRIGHT_CLI_EXECUTABLE

PYTHON_PYRIGHT: CLI Executable

Type: array of string Default: [["pyright"]]

PYTHON_PYRIGHT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_CLI_EXECUTABLE PYTHON_PYRIGHT_CLI_EXECUTABLE items
Type: string

root PYTHON_PYRIGHT_CLI_LINT_MODE

PYTHON_PYRIGHT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_PYRIGHT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS

PYTHON_PYRIGHT: Custom remove arguments

Type: array of string or string

PYTHON_PYRIGHT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_PYRIGHT_CONFIG_FILE

PYTHON_PYRIGHT: Custom config file name

Type: string Default: "pyrightconfig.json"

PYTHON_PYRIGHT: User custom config file name if different from default

root PYTHON_PYRIGHT_DISABLE_ERRORS

PYTHON_PYRIGHT: Disable errors

Type: boolean Default: false

PYTHONPYRIGHT: If true, PYTHONPYRIGHT doesn't make MegaLinter fail even if errors are found

root PYTHON_PYRIGHT_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_PYRIGHT: Maximum number of errors allowed

Type: number Default: 0

PYTHONPYRIGHT: If the number of errors found is less than this value, PYTHONPYRIGHT doesn't make MegaLinter fail

root PYTHON_PYRIGHT_FILE_EXTENSIONS

PYTHON_PYRIGHT: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_PYRIGHT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_FILE_EXTENSIONS PYTHON_PYRIGHT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_PYRIGHT_FILE_NAMES_REGEX

PYTHON_PYRIGHT: Matching file name regexes

Type: array of string Default: []

PYTHON_PYRIGHT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_FILE_NAMES_REGEX PYTHON_PYRIGHT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_PYRIGHT_FILTER_REGEX_EXCLUDE

PYTHON_PYRIGHT: Excluding Regex

Type: string

PYTHON_PYRIGHT: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_PYRIGHT_FILTER_REGEX_INCLUDE

PYTHON_PYRIGHT: Including Regex

Type: string

PYTHON_PYRIGHT: Custom regex including filter: only files matching this regex will be linted

root PYTHON_PYRIGHT_POST_COMMANDS

PYTHON_PYRIGHT: Post-run commands

Type: array

PYTHONPYRIGHT: Define bash commands to run after running PYTHONPYRIGHT

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_PYRIGHT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_PYRIGHT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_PYRIGHT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_PYRIGHT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_PYRIGHT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_PYRIGHT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_PYRIGHT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PYRIGHT_PRE_COMMANDS

PYTHON_PYRIGHT: Pre-run commands

Type: array

PYTHONPYRIGHT: Define bash commands to run before running PYTHONPYRIGHT

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_PYRIGHT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_PYRIGHT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_PYRIGHT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_PYRIGHT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_PYRIGHT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_PYRIGHT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_PYRIGHT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_PYRIGHT_RULES_PATH

PYTHON_PYRIGHT: Custom config file path

Type: string

PYTHON_PYRIGHT: Path where to find linter configuration file

root PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES

PYTHON_PYRIGHT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_PYRIGHT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_RUFF_ARGUMENTS

PYTHON_RUFF: Custom arguments

Type: array of string or string

PYTHON_RUFF: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_ARGUMENTS PYTHON_RUFF_ARGUMENTS items
Type: string

root PYTHON_RUFF_CLI_EXECUTABLE

PYTHON_RUFF: CLI Executable

Type: array of string Default: [["ruff"]]

PYTHON_RUFF: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_CLI_EXECUTABLE PYTHON_RUFF_CLI_EXECUTABLE items
Type: string

root PYTHON_RUFF_CLI_LINT_MODE

PYTHON_RUFF: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHON_RUFF: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS

PYTHON_RUFF: Custom remove arguments

Type: array of string or string

PYTHON_RUFF: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_RUFF_CONFIG_FILE

PYTHON_RUFF: Custom config file name

Type: string Default: ".ruff.toml"

PYTHON_RUFF: User custom config file name if different from default

root PYTHON_RUFF_DISABLE_ERRORS

PYTHON_RUFF: Disable errors

Type: boolean Default: false

PYTHONRUFF: If true, PYTHONRUFF doesn't make MegaLinter fail even if errors are found

root PYTHON_RUFF_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_RUFF: Maximum number of errors allowed

Type: number Default: 0

PYTHONRUFF: If the number of errors found is less than this value, PYTHONRUFF doesn't make MegaLinter fail

root PYTHON_RUFF_FILE_EXTENSIONS

PYTHON_RUFF: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_RUFF: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FILE_EXTENSIONS PYTHON_RUFF_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_RUFF_FILE_NAMES_REGEX

PYTHON_RUFF: Matching file name regexes

Type: array of string Default: []

PYTHON_RUFF: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FILE_NAMES_REGEX PYTHON_RUFF_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_RUFF_FILTER_REGEX_EXCLUDE

PYTHON_RUFF: Excluding Regex

Type: string

PYTHON_RUFF: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_RUFF_FILTER_REGEX_INCLUDE

PYTHON_RUFF: Including Regex

Type: string

PYTHON_RUFF: Custom regex including filter: only files matching this regex will be linted

root PYTHON_RUFF_FORMAT_ARGUMENTS

PYTHON_RUFF_FORMAT: Custom arguments

Type: array of string or string

PYTHONRUFFFORMAT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_ARGUMENTS PYTHON_RUFF_FORMAT_ARGUMENTS items
Type: string

root PYTHON_RUFF_FORMAT_CLI_EXECUTABLE

PYTHON_RUFF_FORMAT: CLI Executable

Type: array of string Default: [["ruff"]]

PYTHONRUFFFORMAT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_CLI_EXECUTABLE PYTHON_RUFF_FORMAT_CLI_EXECUTABLE items
Type: string

root PYTHON_RUFF_FORMAT_CLI_LINT_MODE

PYTHON_RUFF_FORMAT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

PYTHONRUFFFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root PYTHON_RUFF_FORMAT_COMMAND_REMOVE_ARGUMENTS

PYTHON_RUFF_FORMAT: Custom remove arguments

Type: array of string or string

PYTHONRUFFFORMAT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_COMMAND_REMOVE_ARGUMENTS PYTHON_RUFF_FORMAT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root PYTHON_RUFF_FORMAT_CONFIG_FILE

PYTHON_RUFF_FORMAT: Custom config file name

Type: string Default: ".ruff.toml"

PYTHONRUFFFORMAT: User custom config file name if different from default

root PYTHON_RUFF_FORMAT_DISABLE_ERRORS

PYTHON_RUFF_FORMAT: Disable errors

Type: boolean Default: false

PYTHONRUFFFORMAT: If true, PYTHONRUFFFORMAT doesn't make MegaLinter fail even if errors are found

root PYTHON_RUFF_FORMAT_DISABLE_ERRORS_IF_LESS_THAN

PYTHON_RUFF_FORMAT: Maximum number of errors allowed

Type: number Default: 0

PYTHONRUFFFORMAT: If the number of errors found is less than this value, PYTHONRUFFFORMAT doesn't make MegaLinter fail

root PYTHON_RUFF_FORMAT_FILE_EXTENSIONS

PYTHON_RUFF_FORMAT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHONRUFFFORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_FILE_EXTENSIONS PYTHON_RUFF_FORMAT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root PYTHON_RUFF_FORMAT_FILE_NAMES_REGEX

PYTHON_RUFF_FORMAT: Matching file name regexes

Type: array of string Default: []

PYTHONRUFFFORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_FILE_NAMES_REGEX PYTHON_RUFF_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root PYTHON_RUFF_FORMAT_FILTER_REGEX_EXCLUDE

PYTHON_RUFF_FORMAT: Excluding Regex

Type: string

PYTHONRUFFFORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

root PYTHON_RUFF_FORMAT_FILTER_REGEX_INCLUDE

PYTHON_RUFF_FORMAT: Including Regex

Type: string

PYTHONRUFFFORMAT: Custom regex including filter: only files matching this regex will be linted

root PYTHON_RUFF_FORMAT_POST_COMMANDS

PYTHON_RUFF_FORMAT: Post-run commands

Type: array

PYTHONRUFFFORMAT: Define bash commands to run after running PYTHONRUFFFORMAT

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_RUFF_FORMAT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_RUFF_FORMAT_PRE_COMMANDS

PYTHON_RUFF_FORMAT: Pre-run commands

Type: array

PYTHONRUFFFORMAT: Define bash commands to run before running PYTHONRUFFFORMAT

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_RUFF_FORMAT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_RUFF_FORMAT_RULES_PATH

PYTHON_RUFF_FORMAT: Custom config file path

Type: string

PYTHONRUFFFORMAT: Path where to find linter configuration file

root PYTHON_RUFF_FORMAT_UNSECURED_ENV_VARIABLES

PYTHON_RUFF_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHONRUFFFORMAT and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_FORMAT_UNSECURED_ENV_VARIABLES PYTHON_RUFF_FORMAT_UNSECURED_ENV_VARIABLES items
Type: string

root PYTHON_RUFF_POST_COMMANDS

PYTHON_RUFF: Post-run commands

Type: array

PYTHONRUFF: Define bash commands to run after running PYTHONRUFF

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_POST_COMMANDS Command

Command

Type: object

Command information

root PYTHON_RUFF_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_RUFF_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_RUFF_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_RUFF_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_POST_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_RUFF_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_RUFF_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_RUFF_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_RUFF_PRE_COMMANDS

PYTHON_RUFF: Pre-run commands

Type: array

PYTHONRUFF: Define bash commands to run before running PYTHONRUFF

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_PRE_COMMANDS Command

Command

Type: object

Command information

root PYTHON_RUFF_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root PYTHON_RUFF_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root PYTHON_RUFF_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root PYTHON_RUFF_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_PRE_COMMANDS Command output_variables output_variables items
Type: string

root PYTHON_RUFF_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root PYTHON_RUFF_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root PYTHON_RUFF_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root PYTHON_RUFF_RULES_PATH

PYTHON_RUFF: Custom config file path

Type: string

PYTHON_RUFF: Path where to find linter configuration file

root PYTHON_RUFF_UNSECURED_ENV_VARIABLES

PYTHON_RUFF: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling PYTHON_RUFF and its pre/post commands

 No Additional Items

Each item of this array must be:

root PYTHON_RUFF_UNSECURED_ENV_VARIABLES PYTHON_RUFF_UNSECURED_ENV_VARIABLES items
Type: string

root RAKU_FILTER_REGEX_EXCLUDE

Excluding regex filter for RAKU descriptor

Type: string

RAKU: Custom regex excluding filter: files matching this regex will NOT be linted

root RAKU_FILTER_REGEX_INCLUDE

Including regex filter for RAKU descriptor

Type: string

RAKU: Custom regex including filter: only files matching this regex will be linted

root RAKU_POST_COMMANDS

Post commands for RAKU descriptor

Type: array

RAKU: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root RAKU_POST_COMMANDS Command

Command

Type: object

Command information

root RAKU_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RAKU_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RAKU_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RAKU_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RAKU_POST_COMMANDS Command output_variables output_variables items
Type: string

root RAKU_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RAKU_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RAKU_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RAKU_PRE_COMMANDS

Pre commands for RAKU descriptor

Type: array

RAKU: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root RAKU_PRE_COMMANDS Command

Command

Type: object

Command information

root RAKU_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RAKU_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RAKU_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RAKU_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RAKU_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RAKU_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RAKU_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RAKU_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RAKU_RAKU_ARGUMENTS

RAKU_RAKU: Custom arguments

Type: array of string or string

RAKU_RAKU: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_ARGUMENTS RAKU_RAKU_ARGUMENTS items
Type: string

root RAKU_RAKU_CLI_EXECUTABLE

RAKU_RAKU: CLI Executable

Type: array of string Default: [["raku"]]

RAKU_RAKU: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_CLI_EXECUTABLE RAKU_RAKU_CLI_EXECUTABLE items
Type: string

root RAKU_RAKU_CLI_LINT_MODE

RAKU_RAKU: CLI lint mode

Type: enum (of string) Default: "file"

RAKU_RAKU: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS

RAKU_RAKU: Custom remove arguments

Type: array of string or string

RAKU_RAKU: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RAKU_RAKU_CONFIG_FILE

RAKU_RAKU: Custom config file name

Type: string Default: "META6.json"

RAKU_RAKU: User custom config file name if different from default

root RAKU_RAKU_DISABLE_ERRORS

RAKU_RAKU: Disable errors

Type: boolean Default: false

RAKURAKU: If true, RAKURAKU doesn't make MegaLinter fail even if errors are found

root RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN

RAKU_RAKU: Maximum number of errors allowed

Type: number Default: 0

RAKURAKU: If the number of errors found is less than this value, RAKURAKU doesn't make MegaLinter fail

root RAKU_RAKU_FILE_EXTENSIONS

RAKU_RAKU: Matching files extensions

Type: array of string Default: [".raku", ".rakumod", ".rakutest", ".pm6", ".pl6", ".p6"]

RAKU_RAKU: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_FILE_EXTENSIONS RAKU_RAKU_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RAKU_RAKU_FILE_NAMES_REGEX

RAKU_RAKU: Matching file name regexes

Type: array of string Default: []

RAKU_RAKU: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_FILE_NAMES_REGEX RAKU_RAKU_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RAKU_RAKU_FILTER_REGEX_EXCLUDE

RAKU_RAKU: Excluding Regex

Type: string

RAKU_RAKU: Custom regex excluding filter: files matching this regex will NOT be linted

root RAKU_RAKU_FILTER_REGEX_INCLUDE

RAKU_RAKU: Including Regex

Type: string

RAKU_RAKU: Custom regex including filter: only files matching this regex will be linted

root RAKU_RAKU_POST_COMMANDS

RAKU_RAKU: Post-run commands

Type: array

RAKURAKU: Define bash commands to run after running RAKURAKU

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_POST_COMMANDS Command

Command

Type: object

Command information

root RAKU_RAKU_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RAKU_RAKU_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RAKU_RAKU_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RAKU_RAKU_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_POST_COMMANDS Command output_variables output_variables items
Type: string

root RAKU_RAKU_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RAKU_RAKU_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RAKU_RAKU_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RAKU_RAKU_PRE_COMMANDS

RAKU_RAKU: Pre-run commands

Type: array

RAKURAKU: Define bash commands to run before running RAKURAKU

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_PRE_COMMANDS Command

Command

Type: object

Command information

root RAKU_RAKU_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RAKU_RAKU_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RAKU_RAKU_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RAKU_RAKU_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RAKU_RAKU_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RAKU_RAKU_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RAKU_RAKU_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RAKU_RAKU_RULES_PATH

RAKU_RAKU: Custom config file path

Type: string

RAKU_RAKU: Path where to find linter configuration file

root RAKU_RAKU_UNSECURED_ENV_VARIABLES

RAKU_RAKU: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RAKU_RAKU and its pre/post commands

 No Additional Items

Each item of this array must be:

root RAKU_RAKU_UNSECURED_ENV_VARIABLES RAKU_RAKU_UNSECURED_ENV_VARIABLES items
Type: string

root REPORTERS_MARKDOWN_SUMMARY_TYPE

Reporters Markdown Summary type

Type: enum (of string) Default: "table-sections"

Display summary in PR/MR comments as sections, table or both

Must be one of:

  • "sections"
  • "table"
  • "sections-table"
  • "table-sections"

root REPORTERS_MARKDOWN_TYPE

Reporters Markdown type

Type: enum (of string) Default: "advanced"

Define simple if you do not to have external images in PR/MR comments

Must be one of:

  • "simple"
  • "advanced"

root REPORT_OUTPUT_FOLDER

Reports Output folder

Type: string Default: "megalinter-reports"

The location where the output reporting will be generated to

root REPOSITORY_CHECKOV_ARGUMENTS

REPOSITORY_CHECKOV: Custom arguments

Type: array of string or string

REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_ARGUMENTS REPOSITORY_CHECKOV_ARGUMENTS items
Type: string

root REPOSITORY_CHECKOV_CLI_EXECUTABLE

REPOSITORY_CHECKOV: CLI Executable

Type: array of string Default: [["checkov"]]

REPOSITORY_CHECKOV: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_CLI_EXECUTABLE REPOSITORY_CHECKOV_CLI_EXECUTABLE items
Type: string

root REPOSITORY_CHECKOV_CLI_LINT_MODE

REPOSITORY_CHECKOV: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_CHECKOV: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_CHECKOV: Custom remove arguments

Type: array of string or string

REPOSITORY_CHECKOV: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_CHECKOV_CONFIG_FILE

REPOSITORY_CHECKOV: Custom config file name

Type: string Default: ".checkov.yml"

REPOSITORY_CHECKOV: User custom config file name if different from default

root REPOSITORY_CHECKOV_DISABLE_ERRORS

REPOSITORY_CHECKOV: Disable errors

Type: boolean Default: false

REPOSITORYCHECKOV: If true, REPOSITORYCHECKOV doesn't make MegaLinter fail even if errors are found

root REPOSITORY_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_CHECKOV: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYCHECKOV: If the number of errors found is less than this value, REPOSITORYCHECKOV doesn't make MegaLinter fail

root REPOSITORY_CHECKOV_POST_COMMANDS

REPOSITORY_CHECKOV: Post-run commands

Type: array

REPOSITORYCHECKOV: Define bash commands to run after running REPOSITORYCHECKOV

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_CHECKOV_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_CHECKOV_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_CHECKOV_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_CHECKOV_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_CHECKOV_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_CHECKOV_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_CHECKOV_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_CHECKOV_PRE_COMMANDS

REPOSITORY_CHECKOV: Pre-run commands

Type: array

REPOSITORYCHECKOV: Define bash commands to run before running REPOSITORYCHECKOV

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_CHECKOV_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_CHECKOV_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_CHECKOV_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_CHECKOV_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_CHECKOV_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_CHECKOV_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_CHECKOV_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_CHECKOV_RULES_PATH

REPOSITORY_CHECKOV: Custom config file path

Type: string

REPOSITORY_CHECKOV: Path where to find linter configuration file

root REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES

REPOSITORY_CHECKOV: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_CHECKOV and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_DEVSKIM_ARGUMENTS

REPOSITORY_DEVSKIM: Custom arguments

Type: array of string or string

REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_ARGUMENTS REPOSITORY_DEVSKIM_ARGUMENTS items
Type: string

root REPOSITORY_DEVSKIM_CLI_EXECUTABLE

REPOSITORY_DEVSKIM: CLI Executable

Type: array of string Default: [["devskim"]]

REPOSITORY_DEVSKIM: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_CLI_EXECUTABLE REPOSITORY_DEVSKIM_CLI_EXECUTABLE items
Type: string

root REPOSITORY_DEVSKIM_CLI_LINT_MODE

REPOSITORY_DEVSKIM: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_DEVSKIM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_DEVSKIM: Custom remove arguments

Type: array of string or string

REPOSITORY_DEVSKIM: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_DEVSKIM_CONFIG_FILE

REPOSITORY_DEVSKIM: Custom config file name

Type: string Default: ".devskim.json"

REPOSITORY_DEVSKIM: User custom config file name if different from default

root REPOSITORY_DEVSKIM_DISABLE_ERRORS

REPOSITORY_DEVSKIM: Disable errors

Type: boolean Default: false

REPOSITORYDEVSKIM: If true, REPOSITORYDEVSKIM doesn't make MegaLinter fail even if errors are found

root REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_DEVSKIM: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYDEVSKIM: If the number of errors found is less than this value, REPOSITORYDEVSKIM doesn't make MegaLinter fail

root REPOSITORY_DEVSKIM_POST_COMMANDS

REPOSITORY_DEVSKIM: Post-run commands

Type: array

REPOSITORYDEVSKIM: Define bash commands to run after running REPOSITORYDEVSKIM

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_DEVSKIM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_DEVSKIM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_DEVSKIM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_DEVSKIM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_DEVSKIM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_DEVSKIM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_DEVSKIM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_DEVSKIM_PRE_COMMANDS

REPOSITORY_DEVSKIM: Pre-run commands

Type: array

REPOSITORYDEVSKIM: Define bash commands to run before running REPOSITORYDEVSKIM

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_DEVSKIM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_DEVSKIM_RULES_PATH

REPOSITORY_DEVSKIM: Custom config file path

Type: string

REPOSITORY_DEVSKIM: Path where to find linter configuration file

root REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES

REPOSITORY_DEVSKIM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_DEVSKIM and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_DUSTILOCK_ARGUMENTS

REPOSITORY_DUSTILOCK: Custom arguments

Type: array of string or string

REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_ARGUMENTS REPOSITORY_DUSTILOCK_ARGUMENTS items
Type: string

root REPOSITORY_DUSTILOCK_CLI_EXECUTABLE

REPOSITORY_DUSTILOCK: CLI Executable

Type: array of string Default: [["dustilock"]]

REPOSITORY_DUSTILOCK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_CLI_EXECUTABLE REPOSITORY_DUSTILOCK_CLI_EXECUTABLE items
Type: string

root REPOSITORY_DUSTILOCK_CLI_LINT_MODE

REPOSITORY_DUSTILOCK: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_DUSTILOCK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_DUSTILOCK: Custom remove arguments

Type: array of string or string

REPOSITORY_DUSTILOCK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_DUSTILOCK_DISABLE_ERRORS

REPOSITORY_DUSTILOCK: Disable errors

Type: boolean Default: false

REPOSITORYDUSTILOCK: If true, REPOSITORYDUSTILOCK doesn't make MegaLinter fail even if errors are found

root REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_DUSTILOCK: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYDUSTILOCK: If the number of errors found is less than this value, REPOSITORYDUSTILOCK doesn't make MegaLinter fail

root REPOSITORY_DUSTILOCK_POST_COMMANDS

REPOSITORY_DUSTILOCK: Post-run commands

Type: array

REPOSITORYDUSTILOCK: Define bash commands to run after running REPOSITORYDUSTILOCK

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_DUSTILOCK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_DUSTILOCK_PRE_COMMANDS

REPOSITORY_DUSTILOCK: Pre-run commands

Type: array

REPOSITORYDUSTILOCK: Define bash commands to run before running REPOSITORYDUSTILOCK

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_DUSTILOCK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES

REPOSITORY_DUSTILOCK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_DUSTILOCK and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_FILTER_REGEX_EXCLUDE

Excluding regex filter for REPOSITORY descriptor

Type: string

REPOSITORY: Custom regex excluding filter: files matching this regex will NOT be linted

root REPOSITORY_FILTER_REGEX_INCLUDE

Including regex filter for REPOSITORY descriptor

Type: string

REPOSITORY: Custom regex including filter: only files matching this regex will be linted

root REPOSITORY_GITLEAKS_ARGUMENTS

REPOSITORY_GITLEAKS: Custom arguments

Type: array of string or string

REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_ARGUMENTS REPOSITORY_GITLEAKS_ARGUMENTS items
Type: string

root REPOSITORY_GITLEAKS_CLI_EXECUTABLE

REPOSITORY_GITLEAKS: CLI Executable

Type: array of string Default: [["gitleaks"]]

REPOSITORY_GITLEAKS: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_CLI_EXECUTABLE REPOSITORY_GITLEAKS_CLI_EXECUTABLE items
Type: string

root REPOSITORY_GITLEAKS_CLI_LINT_MODE

REPOSITORY_GITLEAKS: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_GITLEAKS: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_GITLEAKS: Custom remove arguments

Type: array of string or string

REPOSITORY_GITLEAKS: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_GITLEAKS_CONFIG_FILE

REPOSITORY_GITLEAKS: Custom config file name

Type: string Default: ".gitleaks.toml"

REPOSITORY_GITLEAKS: User custom config file name if different from default

root REPOSITORY_GITLEAKS_DISABLE_ERRORS

REPOSITORY_GITLEAKS: Disable errors

Type: boolean Default: false

REPOSITORYGITLEAKS: If true, REPOSITORYGITLEAKS doesn't make MegaLinter fail even if errors are found

root REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_GITLEAKS: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYGITLEAKS: If the number of errors found is less than this value, REPOSITORYGITLEAKS doesn't make MegaLinter fail

root REPOSITORY_GITLEAKS_POST_COMMANDS

REPOSITORY_GITLEAKS: Post-run commands

Type: array

REPOSITORYGITLEAKS: Define bash commands to run after running REPOSITORYGITLEAKS

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GITLEAKS_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GITLEAKS_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GITLEAKS_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GITLEAKS_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GITLEAKS_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GITLEAKS_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GITLEAKS_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GITLEAKS_PRE_COMMANDS

REPOSITORY_GITLEAKS: Pre-run commands

Type: array

REPOSITORYGITLEAKS: Define bash commands to run before running REPOSITORYGITLEAKS

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GITLEAKS_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GITLEAKS_PR_COMMITS_SCAN

REPOSITORY_GITLEAKS: Scan only commits in the current Pull Request/Merge Request

Type: boolean Default: false

root REPOSITORY_GITLEAKS_PR_SOURCE_SHA

REPOSITORY_GITLEAKS: Source commit SHA of the Pull Request/Merge Request

Type: string Default: ""

root REPOSITORY_GITLEAKS_PR_TARGET_SHA

REPOSITORY_GITLEAKS: Target commit SHA of the Pull Request/Merge Request

Type: string Default: ""

root REPOSITORY_GITLEAKS_RULES_PATH

REPOSITORY_GITLEAKS: Custom config file path

Type: string

REPOSITORY_GITLEAKS: Path where to find linter configuration file

root REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES

REPOSITORY_GITLEAKS: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_GITLEAKS and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_GIT_DIFF_ARGUMENTS

REPOSITORY_GIT_DIFF: Custom arguments

Type: array of string or string

REPOSITORYGITDIFF: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_ARGUMENTS REPOSITORY_GIT_DIFF_ARGUMENTS items
Type: string

root REPOSITORY_GIT_DIFF_CLI_EXECUTABLE

REPOSITORY_GIT_DIFF: CLI Executable

Type: array of string Default: [["git"]]

REPOSITORYGITDIFF: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_CLI_EXECUTABLE REPOSITORY_GIT_DIFF_CLI_EXECUTABLE items
Type: string

root REPOSITORY_GIT_DIFF_CLI_LINT_MODE

REPOSITORY_GIT_DIFF: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYGITDIFF: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_GIT_DIFF: Custom remove arguments

Type: array of string or string

REPOSITORYGITDIFF: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_GIT_DIFF_DISABLE_ERRORS

REPOSITORY_GIT_DIFF: Disable errors

Type: boolean Default: false

REPOSITORYGITDIFF: If true, REPOSITORYGITDIFF doesn't make MegaLinter fail even if errors are found

root REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_GIT_DIFF: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYGITDIFF: If the number of errors found is less than this value, REPOSITORYGITDIFF doesn't make MegaLinter fail

root REPOSITORY_GIT_DIFF_POST_COMMANDS

REPOSITORY_GIT_DIFF: Post-run commands

Type: array

REPOSITORYGITDIFF: Define bash commands to run after running REPOSITORYGITDIFF

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GIT_DIFF_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GIT_DIFF_PRE_COMMANDS

REPOSITORY_GIT_DIFF: Pre-run commands

Type: array

REPOSITORYGITDIFF: Define bash commands to run before running REPOSITORYGITDIFF

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GIT_DIFF_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES

REPOSITORY_GIT_DIFF: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYGITDIFF and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_GOODCHECK_ARGUMENTS

(removed) REPOSITORY_GOODCHECK: Custom arguments

Type: array of string or string

REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_ARGUMENTS REPOSITORY_GOODCHECK_ARGUMENTS items
Type: string

root REPOSITORY_GOODCHECK_CLI_EXECUTABLE

(removed) REPOSITORY_GOODCHECK: CLI Executable

Type: array of string Default: [["goodcheck"]]
No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_CLI_EXECUTABLE REPOSITORY_GOODCHECK_CLI_EXECUTABLE items
Type: string

root REPOSITORY_GOODCHECK_CONFIG_FILE

(removed) REPOSITORY_GOODCHECK: Custom config file name

Type: string Default: "goodcheck.yml"

REPOSITORY_GOODCHECK: User custom config file name if different from default

root REPOSITORY_GOODCHECK_DISABLE_ERRORS

(removed) REPOSITORY_GOODCHECK: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN

(removed) REPOSITORY_GOODCHECK: Maximum number of errors allowed

Type: number Default: 0

root REPOSITORY_GOODCHECK_POST_COMMANDS

(removed) REPOSITORY_GOODCHECK: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GOODCHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GOODCHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GOODCHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GOODCHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GOODCHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GOODCHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GOODCHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GOODCHECK_PRE_COMMANDS

(removed) REPOSITORY_GOODCHECK: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GOODCHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GOODCHECK_RULES_PATH

(removed) REPOSITORY_GOODCHECK: Custom config file path

Type: string

REPOSITORY_GOODCHECK: Path where to find linter configuration file

root REPOSITORY_GRYPE_ARGUMENTS

REPOSITORY_GRYPE: Custom arguments

Type: array of string or string

REPOSITORY_GRYPE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_ARGUMENTS REPOSITORY_GRYPE_ARGUMENTS items
Type: string

root REPOSITORY_GRYPE_CLI_EXECUTABLE

REPOSITORY_GRYPE: CLI Executable

Type: array of string Default: [["grype"]]

REPOSITORY_GRYPE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_CLI_EXECUTABLE REPOSITORY_GRYPE_CLI_EXECUTABLE items
Type: string

root REPOSITORY_GRYPE_CLI_LINT_MODE

REPOSITORY_GRYPE: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_GRYPE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_GRYPE: Custom remove arguments

Type: array of string or string

REPOSITORY_GRYPE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_GRYPE_CONFIG_FILE

REPOSITORY_GRYPE: Custom config file name

Type: string Default: ".grype.yaml"

REPOSITORY_GRYPE: User custom config file name if different from default

root REPOSITORY_GRYPE_DISABLE_ERRORS

REPOSITORY_GRYPE: Disable errors

Type: boolean Default: false

REPOSITORYGRYPE: If true, REPOSITORYGRYPE doesn't make MegaLinter fail even if errors are found

root REPOSITORY_GRYPE_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_GRYPE: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYGRYPE: If the number of errors found is less than this value, REPOSITORYGRYPE doesn't make MegaLinter fail

root REPOSITORY_GRYPE_POST_COMMANDS

REPOSITORY_GRYPE: Post-run commands

Type: array

REPOSITORYGRYPE: Define bash commands to run after running REPOSITORYGRYPE

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GRYPE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GRYPE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GRYPE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GRYPE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GRYPE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GRYPE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GRYPE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GRYPE_PRE_COMMANDS

REPOSITORY_GRYPE: Pre-run commands

Type: array

REPOSITORYGRYPE: Define bash commands to run before running REPOSITORYGRYPE

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_GRYPE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_GRYPE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_GRYPE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_GRYPE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_GRYPE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_GRYPE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_GRYPE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_GRYPE_RULES_PATH

REPOSITORY_GRYPE: Custom config file path

Type: string

REPOSITORY_GRYPE: Path where to find linter configuration file

root REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES

REPOSITORY_GRYPE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_GRYPE and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_KICS_ARGUMENTS

REPOSITORY_KICS: Custom arguments

Type: array of string or string

REPOSITORY_KICS: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_ARGUMENTS REPOSITORY_KICS_ARGUMENTS items
Type: string

root REPOSITORY_KICS_CLI_EXECUTABLE

REPOSITORY_KICS: CLI Executable

Type: array of string Default: [["kics"]]

REPOSITORY_KICS: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_CLI_EXECUTABLE REPOSITORY_KICS_CLI_EXECUTABLE items
Type: string

root REPOSITORY_KICS_CLI_LINT_MODE

REPOSITORY_KICS: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_KICS: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_KICS: Custom remove arguments

Type: array of string or string

REPOSITORY_KICS: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_KICS_CONFIG_FILE

REPOSITORY_KICS: Custom config file name

Type: string Default: "kics.config"

REPOSITORY_KICS: User custom config file name if different from default

root REPOSITORY_KICS_DISABLE_ERRORS

REPOSITORY_KICS: Disable errors

Type: boolean Default: false

REPOSITORYKICS: If true, REPOSITORYKICS doesn't make MegaLinter fail even if errors are found

root REPOSITORY_KICS_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_KICS: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYKICS: If the number of errors found is less than this value, REPOSITORYKICS doesn't make MegaLinter fail

root REPOSITORY_KICS_POST_COMMANDS

REPOSITORY_KICS: Post-run commands

Type: array

REPOSITORYKICS: Define bash commands to run after running REPOSITORYKICS

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_KICS_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_KICS_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_KICS_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_KICS_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_KICS_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_KICS_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_KICS_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_KICS_PRE_COMMANDS

REPOSITORY_KICS: Pre-run commands

Type: array

REPOSITORYKICS: Define bash commands to run before running REPOSITORYKICS

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_KICS_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_KICS_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_KICS_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_KICS_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_KICS_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_KICS_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_KICS_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_KICS_RULES_PATH

REPOSITORY_KICS: Custom config file path

Type: string

REPOSITORY_KICS: Path where to find linter configuration file

root REPOSITORY_KICS_UNSECURED_ENV_VARIABLES

REPOSITORY_KICS: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_KICS and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_KICS_UNSECURED_ENV_VARIABLES REPOSITORY_KICS_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_KINGFISHER_ARGUMENTS

REPOSITORY_KINGFISHER: Custom arguments

Type: array of string or string

REPOSITORY_KINGFISHER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_ARGUMENTS REPOSITORY_KINGFISHER_ARGUMENTS items
Type: string

root REPOSITORY_KINGFISHER_CLI_EXECUTABLE

REPOSITORY_KINGFISHER: CLI Executable

Type: array of string Default: [["kingfisher"]]

REPOSITORY_KINGFISHER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_CLI_EXECUTABLE REPOSITORY_KINGFISHER_CLI_EXECUTABLE items
Type: string

root REPOSITORY_KINGFISHER_CLI_LINT_MODE

REPOSITORY_KINGFISHER: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_KINGFISHER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_KINGFISHER_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_KINGFISHER: Custom remove arguments

Type: array of string or string

REPOSITORY_KINGFISHER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_COMMAND_REMOVE_ARGUMENTS REPOSITORY_KINGFISHER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_KINGFISHER_DISABLE_ERRORS

REPOSITORY_KINGFISHER: Disable errors

Type: boolean Default: false

REPOSITORYKINGFISHER: If true, REPOSITORYKINGFISHER doesn't make MegaLinter fail even if errors are found

root REPOSITORY_KINGFISHER_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_KINGFISHER: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYKINGFISHER: If the number of errors found is less than this value, REPOSITORYKINGFISHER doesn't make MegaLinter fail

root REPOSITORY_KINGFISHER_POST_COMMANDS

REPOSITORY_KINGFISHER: Post-run commands

Type: array

REPOSITORYKINGFISHER: Define bash commands to run after running REPOSITORYKINGFISHER

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_KINGFISHER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_KINGFISHER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_KINGFISHER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_KINGFISHER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_KINGFISHER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_KINGFISHER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_KINGFISHER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_KINGFISHER_PRE_COMMANDS

REPOSITORY_KINGFISHER: Pre-run commands

Type: array

REPOSITORYKINGFISHER: Define bash commands to run before running REPOSITORYKINGFISHER

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_KINGFISHER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_KINGFISHER_UNSECURED_ENV_VARIABLES

REPOSITORY_KINGFISHER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_KINGFISHER and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_KINGFISHER_UNSECURED_ENV_VARIABLES REPOSITORY_KINGFISHER_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_LS_LINT_ARGUMENTS

REPOSITORY_LS_LINT: Custom arguments

Type: array of string or string

REPOSITORYLSLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_ARGUMENTS REPOSITORY_LS_LINT_ARGUMENTS items
Type: string

root REPOSITORY_LS_LINT_CLI_EXECUTABLE

REPOSITORY_LS_LINT: CLI Executable

Type: array of string Default: [["ls-lint"]]

REPOSITORYLSLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_CLI_EXECUTABLE REPOSITORY_LS_LINT_CLI_EXECUTABLE items
Type: string

root REPOSITORY_LS_LINT_CLI_LINT_MODE

REPOSITORY_LS_LINT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYLSLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_LS_LINT_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_LS_LINT: Custom remove arguments

Type: array of string or string

REPOSITORYLSLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_COMMAND_REMOVE_ARGUMENTS REPOSITORY_LS_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_LS_LINT_CONFIG_FILE

REPOSITORY_LS_LINT: Custom config file name

Type: string Default: ".ls-lint.yml"

REPOSITORYLSLINT: User custom config file name if different from default

root REPOSITORY_LS_LINT_DISABLE_ERRORS

REPOSITORY_LS_LINT: Disable errors

Type: boolean Default: false

REPOSITORYLSLINT: If true, REPOSITORYLSLINT doesn't make MegaLinter fail even if errors are found

root REPOSITORY_LS_LINT_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_LS_LINT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYLSLINT: If the number of errors found is less than this value, REPOSITORYLSLINT doesn't make MegaLinter fail

root REPOSITORY_LS_LINT_POST_COMMANDS

REPOSITORY_LS_LINT: Post-run commands

Type: array

REPOSITORYLSLINT: Define bash commands to run after running REPOSITORYLSLINT

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_LS_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_LS_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_LS_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_LS_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_LS_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_LS_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_LS_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_LS_LINT_PRE_COMMANDS

REPOSITORY_LS_LINT: Pre-run commands

Type: array

REPOSITORYLSLINT: Define bash commands to run before running REPOSITORYLSLINT

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_LS_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_LS_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_LS_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_LS_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_LS_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_LS_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_LS_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_LS_LINT_RULES_PATH

REPOSITORY_LS_LINT: Custom config file path

Type: string

REPOSITORYLSLINT: Path where to find linter configuration file

root REPOSITORY_LS_LINT_UNSECURED_ENV_VARIABLES

REPOSITORY_LS_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYLSLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_LS_LINT_UNSECURED_ENV_VARIABLES REPOSITORY_LS_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_POST_COMMANDS

Post commands for REPOSITORY descriptor

Type: array

REPOSITORY: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root REPOSITORY_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_PRE_COMMANDS

Pre commands for REPOSITORY descriptor

Type: array

REPOSITORY: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root REPOSITORY_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SECRETLINT_ARGUMENTS

REPOSITORY_SECRETLINT: Custom arguments

Type: array of string or string

REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_ARGUMENTS REPOSITORY_SECRETLINT_ARGUMENTS items
Type: string

root REPOSITORY_SECRETLINT_CLI_EXECUTABLE

REPOSITORY_SECRETLINT: CLI Executable

Type: array of string Default: [["secretlint"]]

REPOSITORY_SECRETLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_CLI_EXECUTABLE REPOSITORY_SECRETLINT_CLI_EXECUTABLE items
Type: string

root REPOSITORY_SECRETLINT_CLI_LINT_MODE

REPOSITORY_SECRETLINT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SECRETLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_SECRETLINT: Custom remove arguments

Type: array of string or string

REPOSITORY_SECRETLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_SECRETLINT_CONFIG_FILE

REPOSITORY_SECRETLINT: Custom config file name

Type: string Default: ".secretlintrc.json"

REPOSITORY_SECRETLINT: User custom config file name if different from default

root REPOSITORY_SECRETLINT_DISABLE_ERRORS

REPOSITORY_SECRETLINT: Disable errors

Type: boolean Default: false

REPOSITORYSECRETLINT: If true, REPOSITORYSECRETLINT doesn't make MegaLinter fail even if errors are found

root REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_SECRETLINT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSECRETLINT: If the number of errors found is less than this value, REPOSITORYSECRETLINT doesn't make MegaLinter fail

root REPOSITORY_SECRETLINT_POST_COMMANDS

REPOSITORY_SECRETLINT: Post-run commands

Type: array

REPOSITORYSECRETLINT: Define bash commands to run after running REPOSITORYSECRETLINT

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SECRETLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SECRETLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SECRETLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SECRETLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SECRETLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SECRETLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SECRETLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SECRETLINT_PRE_COMMANDS

REPOSITORY_SECRETLINT: Pre-run commands

Type: array

REPOSITORYSECRETLINT: Define bash commands to run before running REPOSITORYSECRETLINT

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SECRETLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SECRETLINT_RULES_PATH

REPOSITORY_SECRETLINT: Custom config file path

Type: string

REPOSITORY_SECRETLINT: Path where to find linter configuration file

root REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES

REPOSITORY_SECRETLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SECRETLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_SEMGREP_ARGUMENTS

REPOSITORY_SEMGREP: Custom arguments

Type: array of string or string

REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_ARGUMENTS REPOSITORY_SEMGREP_ARGUMENTS items
Type: string

root REPOSITORY_SEMGREP_CLI_EXECUTABLE

REPOSITORY_SEMGREP: CLI Executable

Type: array of string Default: [["semgrep"]]

REPOSITORY_SEMGREP: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_CLI_EXECUTABLE REPOSITORY_SEMGREP_CLI_EXECUTABLE items
Type: string

root REPOSITORY_SEMGREP_CLI_LINT_MODE

REPOSITORY_SEMGREP: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SEMGREP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_SEMGREP: Custom remove arguments

Type: array of string or string

REPOSITORY_SEMGREP: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_SEMGREP_DISABLE_ERRORS

REPOSITORY_SEMGREP: Disable errors

Type: boolean Default: false

REPOSITORYSEMGREP: If true, REPOSITORYSEMGREP doesn't make MegaLinter fail even if errors are found

root REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_SEMGREP: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSEMGREP: If the number of errors found is less than this value, REPOSITORYSEMGREP doesn't make MegaLinter fail

root REPOSITORY_SEMGREP_POST_COMMANDS

REPOSITORY_SEMGREP: Post-run commands

Type: array

REPOSITORYSEMGREP: Define bash commands to run after running REPOSITORYSEMGREP

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SEMGREP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SEMGREP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SEMGREP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SEMGREP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SEMGREP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SEMGREP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SEMGREP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SEMGREP_PRE_COMMANDS

REPOSITORY_SEMGREP: Pre-run commands

Type: array

REPOSITORYSEMGREP: Define bash commands to run before running REPOSITORYSEMGREP

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SEMGREP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SEMGREP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SEMGREP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SEMGREP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SEMGREP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SEMGREP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SEMGREP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SEMGREP_RULESETS

REPOSITORY_SEMGREP: Custom arguments

Type: array of string or string

REPOSITORY_SEMGREP: Specify custom ruleset(s) for semgrep

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_RULESETS REPOSITORY_SEMGREP_RULESETS items
Type: string

root REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES

REPOSITORY_SEMGREP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SEMGREP and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_SYFT_ARGUMENTS

REPOSITORY_SYFT: Custom arguments

Type: array of string or string

REPOSITORY_SYFT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_ARGUMENTS REPOSITORY_SYFT_ARGUMENTS items
Type: string

root REPOSITORY_SYFT_CLI_EXECUTABLE

REPOSITORY_SYFT: CLI Executable

Type: array of string Default: [["syft"]]

REPOSITORY_SYFT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_CLI_EXECUTABLE REPOSITORY_SYFT_CLI_EXECUTABLE items
Type: string

root REPOSITORY_SYFT_CLI_LINT_MODE

REPOSITORY_SYFT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SYFT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_SYFT: Custom remove arguments

Type: array of string or string

REPOSITORY_SYFT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_SYFT_CONFIG_FILE

REPOSITORY_SYFT: Custom config file name

Type: string Default: ".syft.yaml"

REPOSITORY_SYFT: User custom config file name if different from default

root REPOSITORY_SYFT_DISABLE_ERRORS

REPOSITORY_SYFT: Disable errors

Type: boolean Default: false

REPOSITORYSYFT: If true, REPOSITORYSYFT doesn't make MegaLinter fail even if errors are found

root REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_SYFT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSYFT: If the number of errors found is less than this value, REPOSITORYSYFT doesn't make MegaLinter fail

root REPOSITORY_SYFT_POST_COMMANDS

REPOSITORY_SYFT: Post-run commands

Type: array

REPOSITORYSYFT: Define bash commands to run after running REPOSITORYSYFT

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SYFT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SYFT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SYFT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SYFT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SYFT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SYFT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SYFT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SYFT_PRE_COMMANDS

REPOSITORY_SYFT: Pre-run commands

Type: array

REPOSITORYSYFT: Define bash commands to run before running REPOSITORYSYFT

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_SYFT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_SYFT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_SYFT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_SYFT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_SYFT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_SYFT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_SYFT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_SYFT_RULES_PATH

REPOSITORY_SYFT: Custom config file path

Type: string

REPOSITORY_SYFT: Path where to find linter configuration file

root REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES

REPOSITORY_SYFT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SYFT and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_TRIVY_ARGUMENTS

REPOSITORY_TRIVY: Custom arguments

Type: array of string or string

REPOSITORY_TRIVY: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_ARGUMENTS REPOSITORY_TRIVY_ARGUMENTS items
Type: string

root REPOSITORY_TRIVY_CLI_EXECUTABLE

REPOSITORY_TRIVY: CLI Executable

Type: array of string Default: [["trivy"]]

REPOSITORY_TRIVY: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_CLI_EXECUTABLE REPOSITORY_TRIVY_CLI_EXECUTABLE items
Type: string

root REPOSITORY_TRIVY_CLI_LINT_MODE

REPOSITORY_TRIVY: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_TRIVY: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_TRIVY: Custom remove arguments

Type: array of string or string

REPOSITORY_TRIVY: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_TRIVY_CONFIG_FILE

REPOSITORY_TRIVY: Custom config file name

Type: string Default: "trivy.yaml"

REPOSITORY_TRIVY: User custom config file name if different from default

root REPOSITORY_TRIVY_DISABLE_ERRORS

REPOSITORY_TRIVY: Disable errors

Type: boolean Default: false

REPOSITORYTRIVY: If true, REPOSITORYTRIVY doesn't make MegaLinter fail even if errors are found

root REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_TRIVY: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRIVY: If the number of errors found is less than this value, REPOSITORYTRIVY doesn't make MegaLinter fail

root REPOSITORY_TRIVY_POST_COMMANDS

REPOSITORY_TRIVY: Post-run commands

Type: array

REPOSITORYTRIVY: Define bash commands to run after running REPOSITORYTRIVY

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRIVY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRIVY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRIVY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRIVY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRIVY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRIVY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRIVY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRIVY_PRE_COMMANDS

REPOSITORY_TRIVY: Pre-run commands

Type: array

REPOSITORYTRIVY: Define bash commands to run before running REPOSITORYTRIVY

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRIVY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRIVY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRIVY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRIVY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRIVY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRIVY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRIVY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRIVY_RULES_PATH

REPOSITORY_TRIVY: Custom config file path

Type: string

REPOSITORY_TRIVY: Path where to find linter configuration file

root REPOSITORY_TRIVY_SBOM_ARGUMENTS

REPOSITORY_TRIVY_SBOM: Custom arguments

Type: array of string or string

REPOSITORYTRIVYSBOM: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_ARGUMENTS REPOSITORY_TRIVY_SBOM_ARGUMENTS items
Type: string

root REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE

REPOSITORY_TRIVY_SBOM: CLI Executable

Type: array of string Default: [["trivy"]]

REPOSITORYTRIVYSBOM: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE items
Type: string

root REPOSITORY_TRIVY_SBOM_CLI_LINT_MODE

REPOSITORY_TRIVY_SBOM: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYTRIVYSBOM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_TRIVY_SBOM: Custom remove arguments

Type: array of string or string

REPOSITORYTRIVYSBOM: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_TRIVY_SBOM_CONFIG_FILE

REPOSITORY_TRIVY_SBOM: Custom config file name

Type: string Default: "trivy-sbom.yaml"

REPOSITORYTRIVYSBOM: User custom config file name if different from default

root REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS

REPOSITORY_TRIVY_SBOM: Disable errors

Type: boolean Default: false

REPOSITORYTRIVYSBOM: If true, REPOSITORYTRIVYSBOM doesn't make MegaLinter fail even if errors are found

root REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_TRIVY_SBOM: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRIVYSBOM: If the number of errors found is less than this value, REPOSITORYTRIVYSBOM doesn't make MegaLinter fail

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS

REPOSITORY_TRIVY_SBOM: Post-run commands

Type: array

REPOSITORYTRIVYSBOM: Define bash commands to run after running REPOSITORYTRIVYSBOM

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRIVY_SBOM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS

REPOSITORY_TRIVY_SBOM: Pre-run commands

Type: array

REPOSITORYTRIVYSBOM: Define bash commands to run before running REPOSITORYTRIVYSBOM

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRIVY_SBOM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRIVY_SBOM_RULES_PATH

REPOSITORY_TRIVY_SBOM: Custom config file path

Type: string

REPOSITORYTRIVYSBOM: Path where to find linter configuration file

root REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES

REPOSITORY_TRIVY_SBOM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYTRIVYSBOM and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES

REPOSITORY_TRIVY: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_TRIVY and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES items
Type: string

root REPOSITORY_TRUFFLEHOG_ARGUMENTS

REPOSITORY_TRUFFLEHOG: Custom arguments

Type: array of string or string

REPOSITORY_TRUFFLEHOG: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_ARGUMENTS REPOSITORY_TRUFFLEHOG_ARGUMENTS items
Type: string

root REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE

REPOSITORY_TRUFFLEHOG: CLI Executable

Type: array of string Default: [["trufflehog"]]

REPOSITORY_TRUFFLEHOG: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE items
Type: string

root REPOSITORY_TRUFFLEHOG_CLI_LINT_MODE

REPOSITORY_TRUFFLEHOG: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_TRUFFLEHOG: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS

REPOSITORY_TRUFFLEHOG: Custom remove arguments

Type: array of string or string

REPOSITORY_TRUFFLEHOG: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS items
Type: string

root REPOSITORY_TRUFFLEHOG_CONFIG_FILE

REPOSITORY_TRUFFLEHOG: Custom config file name

Type: string Default: ".trufflehog.yml"

REPOSITORY_TRUFFLEHOG: User custom config file name if different from default

root REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS

REPOSITORY_TRUFFLEHOG: Disable errors

Type: boolean Default: false

REPOSITORYTRUFFLEHOG: If true, REPOSITORYTRUFFLEHOG doesn't make MegaLinter fail even if errors are found

root REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS_IF_LESS_THAN

REPOSITORY_TRUFFLEHOG: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRUFFLEHOG: If the number of errors found is less than this value, REPOSITORYTRUFFLEHOG doesn't make MegaLinter fail

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS

REPOSITORY_TRUFFLEHOG: Post-run commands

Type: array

REPOSITORYTRUFFLEHOG: Define bash commands to run after running REPOSITORYTRUFFLEHOG

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRUFFLEHOG_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS

REPOSITORY_TRUFFLEHOG: Pre-run commands

Type: array

REPOSITORYTRUFFLEHOG: Define bash commands to run before running REPOSITORYTRUFFLEHOG

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command

Command

Type: object

Command information

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command output_variables output_variables items
Type: string

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root REPOSITORY_TRUFFLEHOG_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root REPOSITORY_TRUFFLEHOG_RULES_PATH

REPOSITORY_TRUFFLEHOG: Custom config file path

Type: string

REPOSITORY_TRUFFLEHOG: Path where to find linter configuration file

root REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES

REPOSITORY_TRUFFLEHOG: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_TRUFFLEHOG and its pre/post commands

 No Additional Items

Each item of this array must be:

root REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES items
Type: string

root ROBOTFRAMEWORK_FILTER_REGEX_EXCLUDE

Excluding regex filter for ROBOTFRAMEWORK descriptor

Type: string

ROBOTFRAMEWORK: Custom regex excluding filter: files matching this regex will NOT be linted

root ROBOTFRAMEWORK_FILTER_REGEX_INCLUDE

Including regex filter for ROBOTFRAMEWORK descriptor

Type: string

ROBOTFRAMEWORK: Custom regex including filter: only files matching this regex will be linted

root ROBOTFRAMEWORK_POST_COMMANDS

Post commands for ROBOTFRAMEWORK descriptor

Type: array

ROBOTFRAMEWORK: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_POST_COMMANDS Command

Command

Type: object

Command information

root ROBOTFRAMEWORK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ROBOTFRAMEWORK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ROBOTFRAMEWORK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ROBOTFRAMEWORK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_POST_COMMANDS Command output_variables output_variables items
Type: string

root ROBOTFRAMEWORK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ROBOTFRAMEWORK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ROBOTFRAMEWORK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ROBOTFRAMEWORK_PRE_COMMANDS

Pre commands for ROBOTFRAMEWORK descriptor

Type: array

ROBOTFRAMEWORK: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_PRE_COMMANDS Command

Command

Type: object

Command information

root ROBOTFRAMEWORK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ROBOTFRAMEWORK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ROBOTFRAMEWORK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ROBOTFRAMEWORK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ROBOTFRAMEWORK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ROBOTFRAMEWORK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ROBOTFRAMEWORK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ROBOTFRAMEWORK_ROBOCOP_ARGUMENTS

ROBOTFRAMEWORK_ROBOCOP: Custom arguments

Type: array of string or string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_ARGUMENTS ROBOTFRAMEWORK_ROBOCOP_ARGUMENTS items
Type: string

root ROBOTFRAMEWORK_ROBOCOP_CLI_EXECUTABLE

ROBOTFRAMEWORK_ROBOCOP: CLI Executable

Type: array of string Default: [["robocop"]]

ROBOTFRAMEWORK_ROBOCOP: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_CLI_EXECUTABLE ROBOTFRAMEWORK_ROBOCOP_CLI_EXECUTABLE items
Type: string

root ROBOTFRAMEWORK_ROBOCOP_CLI_LINT_MODE

ROBOTFRAMEWORK_ROBOCOP: CLI lint mode

Type: enum (of string) Default: "list_of_files"

ROBOTFRAMEWORK_ROBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root ROBOTFRAMEWORK_ROBOCOP_COMMAND_REMOVE_ARGUMENTS

ROBOTFRAMEWORK_ROBOCOP: Custom remove arguments

Type: array of string or string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_COMMAND_REMOVE_ARGUMENTS ROBOTFRAMEWORK_ROBOCOP_COMMAND_REMOVE_ARGUMENTS items
Type: string

root ROBOTFRAMEWORK_ROBOCOP_CONFIG_FILE

ROBOTFRAMEWORK_ROBOCOP: Custom config file name

Type: string Default: "robocop.toml"

ROBOTFRAMEWORK_ROBOCOP: User custom config file name if different from default

root ROBOTFRAMEWORK_ROBOCOP_DISABLE_ERRORS

ROBOTFRAMEWORK_ROBOCOP: Disable errors

Type: boolean Default: false

ROBOTFRAMEWORKROBOCOP: If true, ROBOTFRAMEWORKROBOCOP doesn't make MegaLinter fail even if errors are found

root ROBOTFRAMEWORK_ROBOCOP_DISABLE_ERRORS_IF_LESS_THAN

ROBOTFRAMEWORK_ROBOCOP: Maximum number of errors allowed

Type: number Default: 0

ROBOTFRAMEWORKROBOCOP: If the number of errors found is less than this value, ROBOTFRAMEWORKROBOCOP doesn't make MegaLinter fail

root ROBOTFRAMEWORK_ROBOCOP_FILE_EXTENSIONS

ROBOTFRAMEWORK_ROBOCOP: Matching files extensions

Type: array of string Default: [".robot", ".resource"]

ROBOTFRAMEWORK_ROBOCOP: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_FILE_EXTENSIONS ROBOTFRAMEWORK_ROBOCOP_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root ROBOTFRAMEWORK_ROBOCOP_FILE_NAMES_REGEX

ROBOTFRAMEWORK_ROBOCOP: Matching file name regexes

Type: array of string Default: []

ROBOTFRAMEWORK_ROBOCOP: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_FILE_NAMES_REGEX ROBOTFRAMEWORK_ROBOCOP_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root ROBOTFRAMEWORK_ROBOCOP_FILTER_REGEX_EXCLUDE

ROBOTFRAMEWORK_ROBOCOP: Excluding Regex

Type: string

ROBOTFRAMEWORK_ROBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted

root ROBOTFRAMEWORK_ROBOCOP_FILTER_REGEX_INCLUDE

ROBOTFRAMEWORK_ROBOCOP: Including Regex

Type: string

ROBOTFRAMEWORK_ROBOCOP: Custom regex including filter: only files matching this regex will be linted

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS

ROBOTFRAMEWORK_ROBOCOP: Post-run commands

Type: array

ROBOTFRAMEWORKROBOCOP: Define bash commands to run after running ROBOTFRAMEWORKROBOCOP

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command

Command

Type: object

Command information

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command output_variables output_variables items
Type: string

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS

ROBOTFRAMEWORK_ROBOCOP: Pre-run commands

Type: array

ROBOTFRAMEWORKROBOCOP: Define bash commands to run before running ROBOTFRAMEWORKROBOCOP

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command

Command

Type: object

Command information

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root ROBOTFRAMEWORK_ROBOCOP_RULES_PATH

ROBOTFRAMEWORK_ROBOCOP: Custom config file path

Type: string

ROBOTFRAMEWORK_ROBOCOP: Path where to find linter configuration file

root ROBOTFRAMEWORK_ROBOCOP_UNSECURED_ENV_VARIABLES

ROBOTFRAMEWORK_ROBOCOP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ROBOTFRAMEWORK_ROBOCOP and its pre/post commands

 No Additional Items

Each item of this array must be:

root ROBOTFRAMEWORK_ROBOCOP_UNSECURED_ENV_VARIABLES ROBOTFRAMEWORK_ROBOCOP_UNSECURED_ENV_VARIABLES items
Type: string

root RST_FILTER_REGEX_EXCLUDE

Excluding regex filter for RST descriptor

Type: string

RST: Custom regex excluding filter: files matching this regex will NOT be linted

root RST_FILTER_REGEX_INCLUDE

Including regex filter for RST descriptor

Type: string

RST: Custom regex including filter: only files matching this regex will be linted

root RST_POST_COMMANDS

Post commands for RST descriptor

Type: array

RST: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root RST_POST_COMMANDS Command

Command

Type: object

Command information

root RST_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_POST_COMMANDS Command output_variables output_variables items
Type: string

root RST_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_PRE_COMMANDS

Pre commands for RST descriptor

Type: array

RST: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root RST_PRE_COMMANDS Command

Command

Type: object

Command information

root RST_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RST_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RSTCHECK_ARGUMENTS

RST_RSTCHECK: Custom arguments

Type: array of string or string

RST_RSTCHECK: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_ARGUMENTS RST_RSTCHECK_ARGUMENTS items
Type: string

root RST_RSTCHECK_CLI_EXECUTABLE

RST_RSTCHECK: CLI Executable

Type: array of string Default: [["rstcheck"]]

RST_RSTCHECK: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_CLI_EXECUTABLE RST_RSTCHECK_CLI_EXECUTABLE items
Type: string

root RST_RSTCHECK_CLI_LINT_MODE

RST_RSTCHECK: CLI lint mode

Type: enum (of string) Default: "file"

RST_RSTCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS

RST_RSTCHECK: Custom remove arguments

Type: array of string or string

RST_RSTCHECK: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RST_RSTCHECK_CONFIG_FILE

RST_RSTCHECK: Custom config file name

Type: string Default: ".rstcheck.cfg"

RST_RSTCHECK: User custom config file name if different from default

root RST_RSTCHECK_DISABLE_ERRORS

RST_RSTCHECK: Disable errors

Type: boolean Default: false

RSTRSTCHECK: If true, RSTRSTCHECK doesn't make MegaLinter fail even if errors are found

root RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN

RST_RSTCHECK: Maximum number of errors allowed

Type: number Default: 0

RSTRSTCHECK: If the number of errors found is less than this value, RSTRSTCHECK doesn't make MegaLinter fail

root RST_RSTCHECK_FILE_EXTENSIONS

RST_RSTCHECK: Matching files extensions

Type: array of string Default: [".rst"]

RST_RSTCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_FILE_EXTENSIONS RST_RSTCHECK_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RST_RSTCHECK_FILE_NAMES_REGEX

RST_RSTCHECK: Matching file name regexes

Type: array of string Default: []

RST_RSTCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_FILE_NAMES_REGEX RST_RSTCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RST_RSTCHECK_FILTER_REGEX_EXCLUDE

RST_RSTCHECK: Excluding Regex

Type: string

RST_RSTCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

root RST_RSTCHECK_FILTER_REGEX_INCLUDE

RST_RSTCHECK: Including Regex

Type: string

RST_RSTCHECK: Custom regex including filter: only files matching this regex will be linted

root RST_RSTCHECK_POST_COMMANDS

RST_RSTCHECK: Post-run commands

Type: array

RSTRSTCHECK: Define bash commands to run after running RSTRSTCHECK

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_POST_COMMANDS Command

Command

Type: object

Command information

root RST_RSTCHECK_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RSTCHECK_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RSTCHECK_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RSTCHECK_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_POST_COMMANDS Command output_variables output_variables items
Type: string

root RST_RSTCHECK_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RSTCHECK_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RSTCHECK_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RSTCHECK_PRE_COMMANDS

RST_RSTCHECK: Pre-run commands

Type: array

RSTRSTCHECK: Define bash commands to run before running RSTRSTCHECK

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_PRE_COMMANDS Command

Command

Type: object

Command information

root RST_RSTCHECK_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RSTCHECK_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RSTCHECK_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RSTCHECK_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RST_RSTCHECK_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RSTCHECK_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RSTCHECK_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RSTCHECK_RULES_PATH

RST_RSTCHECK: Custom config file path

Type: string

RST_RSTCHECK: Path where to find linter configuration file

root RST_RSTCHECK_UNSECURED_ENV_VARIABLES

RST_RSTCHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RST_RSTCHECK and its pre/post commands

 No Additional Items

Each item of this array must be:

root RST_RSTCHECK_UNSECURED_ENV_VARIABLES RST_RSTCHECK_UNSECURED_ENV_VARIABLES items
Type: string

root RST_RSTFMT_ARGUMENTS

RST_RSTFMT: Custom arguments

Type: array of string or string

RST_RSTFMT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_ARGUMENTS RST_RSTFMT_ARGUMENTS items
Type: string

root RST_RSTFMT_CLI_EXECUTABLE

RST_RSTFMT: CLI Executable

Type: array of string Default: [["rstfmt"]]

RST_RSTFMT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_CLI_EXECUTABLE RST_RSTFMT_CLI_EXECUTABLE items
Type: string

root RST_RSTFMT_CLI_LINT_MODE

RST_RSTFMT: CLI lint mode

Type: enum (of string) Default: "file"

RST_RSTFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS

RST_RSTFMT: Custom remove arguments

Type: array of string or string

RST_RSTFMT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RST_RSTFMT_DISABLE_ERRORS

RST_RSTFMT: Disable errors

Type: boolean Default: false

RSTRSTFMT: If true, RSTRSTFMT doesn't make MegaLinter fail even if errors are found

root RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN

RST_RSTFMT: Maximum number of errors allowed

Type: number Default: 0

RSTRSTFMT: If the number of errors found is less than this value, RSTRSTFMT doesn't make MegaLinter fail

root RST_RSTFMT_FILE_EXTENSIONS

RST_RSTFMT: Matching files extensions

Type: array of string Default: [".rst"]

RST_RSTFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_FILE_EXTENSIONS RST_RSTFMT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RST_RSTFMT_FILE_NAMES_REGEX

RST_RSTFMT: Matching file name regexes

Type: array of string Default: []

RST_RSTFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_FILE_NAMES_REGEX RST_RSTFMT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RST_RSTFMT_FILTER_REGEX_EXCLUDE

RST_RSTFMT: Excluding Regex

Type: string

RST_RSTFMT: Custom regex excluding filter: files matching this regex will NOT be linted

root RST_RSTFMT_FILTER_REGEX_INCLUDE

RST_RSTFMT: Including Regex

Type: string

RST_RSTFMT: Custom regex including filter: only files matching this regex will be linted

root RST_RSTFMT_POST_COMMANDS

RST_RSTFMT: Post-run commands

Type: array

RSTRSTFMT: Define bash commands to run after running RSTRSTFMT

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_POST_COMMANDS Command

Command

Type: object

Command information

root RST_RSTFMT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RSTFMT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RSTFMT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RSTFMT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_POST_COMMANDS Command output_variables output_variables items
Type: string

root RST_RSTFMT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RSTFMT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RSTFMT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RSTFMT_PRE_COMMANDS

RST_RSTFMT: Pre-run commands

Type: array

RSTRSTFMT: Define bash commands to run before running RSTRSTFMT

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_PRE_COMMANDS Command

Command

Type: object

Command information

root RST_RSTFMT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RSTFMT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RSTFMT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RSTFMT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RST_RSTFMT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RSTFMT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RSTFMT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RSTFMT_UNSECURED_ENV_VARIABLES

RST_RSTFMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RST_RSTFMT and its pre/post commands

 No Additional Items

Each item of this array must be:

root RST_RSTFMT_UNSECURED_ENV_VARIABLES RST_RSTFMT_UNSECURED_ENV_VARIABLES items
Type: string

root RST_RST_LINT_ARGUMENTS

RST_RST_LINT: Custom arguments

Type: array of string or string

RSTRSTLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_ARGUMENTS RST_RST_LINT_ARGUMENTS items
Type: string

root RST_RST_LINT_CLI_EXECUTABLE

RST_RST_LINT: CLI Executable

Type: array of string Default: [["rst-lint"]]

RSTRSTLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_CLI_EXECUTABLE RST_RST_LINT_CLI_EXECUTABLE items
Type: string

root RST_RST_LINT_CLI_LINT_MODE

RST_RST_LINT: CLI lint mode

Type: enum (of string) Default: "file"

RSTRSTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS

RST_RST_LINT: Custom remove arguments

Type: array of string or string

RSTRSTLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RST_RST_LINT_DISABLE_ERRORS

RST_RST_LINT: Disable errors

Type: boolean Default: false

RSTRSTLINT: If true, RSTRSTLINT doesn't make MegaLinter fail even if errors are found

root RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN

RST_RST_LINT: Maximum number of errors allowed

Type: number Default: 0

RSTRSTLINT: If the number of errors found is less than this value, RSTRSTLINT doesn't make MegaLinter fail

root RST_RST_LINT_FILE_EXTENSIONS

RST_RST_LINT: Matching files extensions

Type: array of string Default: [".rst"]

RSTRSTLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_FILE_EXTENSIONS RST_RST_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RST_RST_LINT_FILE_NAMES_REGEX

RST_RST_LINT: Matching file name regexes

Type: array of string Default: []

RSTRSTLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_FILE_NAMES_REGEX RST_RST_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RST_RST_LINT_FILTER_REGEX_EXCLUDE

RST_RST_LINT: Excluding Regex

Type: string

RSTRSTLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root RST_RST_LINT_FILTER_REGEX_INCLUDE

RST_RST_LINT: Including Regex

Type: string

RSTRSTLINT: Custom regex including filter: only files matching this regex will be linted

root RST_RST_LINT_POST_COMMANDS

RST_RST_LINT: Post-run commands

Type: array

RSTRSTLINT: Define bash commands to run after running RSTRSTLINT

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root RST_RST_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RST_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RST_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RST_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root RST_RST_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RST_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RST_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RST_LINT_PRE_COMMANDS

RST_RST_LINT: Pre-run commands

Type: array

RSTRSTLINT: Define bash commands to run before running RSTRSTLINT

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root RST_RST_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RST_RST_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RST_RST_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RST_RST_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RST_RST_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RST_RST_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RST_RST_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RST_RST_LINT_UNSECURED_ENV_VARIABLES

RST_RST_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RSTRSTLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root RST_RST_LINT_UNSECURED_ENV_VARIABLES RST_RST_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root RUBY_FILTER_REGEX_EXCLUDE

Excluding regex filter for RUBY descriptor

Type: string

RUBY: Custom regex excluding filter: files matching this regex will NOT be linted

root RUBY_FILTER_REGEX_INCLUDE

Including regex filter for RUBY descriptor

Type: string

RUBY: Custom regex including filter: only files matching this regex will be linted

root RUBY_POST_COMMANDS

Post commands for RUBY descriptor

Type: array

RUBY: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root RUBY_POST_COMMANDS Command

Command

Type: object

Command information

root RUBY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUBY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUBY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUBY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUBY_POST_COMMANDS Command output_variables output_variables items
Type: string

root RUBY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUBY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUBY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUBY_PRE_COMMANDS

Pre commands for RUBY descriptor

Type: array

RUBY: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root RUBY_PRE_COMMANDS Command

Command

Type: object

Command information

root RUBY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUBY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUBY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUBY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUBY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RUBY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUBY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUBY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUBY_RUBOCOP_ARGUMENTS

RUBY_RUBOCOP: Custom arguments

Type: array of string or string

RUBY_RUBOCOP: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_ARGUMENTS RUBY_RUBOCOP_ARGUMENTS items
Type: string

root RUBY_RUBOCOP_CLI_EXECUTABLE

RUBY_RUBOCOP: CLI Executable

Type: array of string Default: [["rubocop"]]

RUBY_RUBOCOP: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_CLI_EXECUTABLE RUBY_RUBOCOP_CLI_EXECUTABLE items
Type: string

root RUBY_RUBOCOP_CLI_LINT_MODE

RUBY_RUBOCOP: CLI lint mode

Type: enum (of string) Default: "file"

RUBY_RUBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS

RUBY_RUBOCOP: Custom remove arguments

Type: array of string or string

RUBY_RUBOCOP: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RUBY_RUBOCOP_CONFIG_FILE

RUBY_RUBOCOP: Custom config file name

Type: string Default: ".ruby-lint.yml"

RUBY_RUBOCOP: User custom config file name if different from default

root RUBY_RUBOCOP_DISABLE_ERRORS

RUBY_RUBOCOP: Disable errors

Type: boolean Default: false

RUBYRUBOCOP: If true, RUBYRUBOCOP doesn't make MegaLinter fail even if errors are found

root RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN

RUBY_RUBOCOP: Maximum number of errors allowed

Type: number Default: 0

RUBYRUBOCOP: If the number of errors found is less than this value, RUBYRUBOCOP doesn't make MegaLinter fail

root RUBY_RUBOCOP_FILE_EXTENSIONS

RUBY_RUBOCOP: Matching files extensions

Type: array of string Default: [".rb"]

RUBY_RUBOCOP: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_FILE_EXTENSIONS RUBY_RUBOCOP_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RUBY_RUBOCOP_FILE_NAMES_REGEX

RUBY_RUBOCOP: Matching file name regexes

Type: array of string Default: []

RUBY_RUBOCOP: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_FILE_NAMES_REGEX RUBY_RUBOCOP_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE

RUBY_RUBOCOP: Excluding Regex

Type: string

RUBY_RUBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted

root RUBY_RUBOCOP_FILTER_REGEX_INCLUDE

RUBY_RUBOCOP: Including Regex

Type: string

RUBY_RUBOCOP: Custom regex including filter: only files matching this regex will be linted

root RUBY_RUBOCOP_POST_COMMANDS

RUBY_RUBOCOP: Post-run commands

Type: array

RUBYRUBOCOP: Define bash commands to run after running RUBYRUBOCOP

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_POST_COMMANDS Command

Command

Type: object

Command information

root RUBY_RUBOCOP_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUBY_RUBOCOP_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUBY_RUBOCOP_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUBY_RUBOCOP_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_POST_COMMANDS Command output_variables output_variables items
Type: string

root RUBY_RUBOCOP_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUBY_RUBOCOP_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUBY_RUBOCOP_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUBY_RUBOCOP_PRE_COMMANDS

RUBY_RUBOCOP: Pre-run commands

Type: array

RUBYRUBOCOP: Define bash commands to run before running RUBYRUBOCOP

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_PRE_COMMANDS Command

Command

Type: object

Command information

root RUBY_RUBOCOP_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUBY_RUBOCOP_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUBY_RUBOCOP_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUBY_RUBOCOP_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RUBY_RUBOCOP_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUBY_RUBOCOP_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUBY_RUBOCOP_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUBY_RUBOCOP_RULES_PATH

RUBY_RUBOCOP: Custom config file path

Type: string

RUBY_RUBOCOP: Path where to find linter configuration file

root RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES

RUBY_RUBOCOP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RUBY_RUBOCOP and its pre/post commands

 No Additional Items

Each item of this array must be:

root RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES items
Type: string

root RUST_CLIPPY_ARGUMENTS

RUST_CLIPPY: Custom arguments

Type: array of string or string

RUST_CLIPPY: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_ARGUMENTS RUST_CLIPPY_ARGUMENTS items
Type: string

root RUST_CLIPPY_CLI_EXECUTABLE

RUST_CLIPPY: CLI Executable

Type: array of string Default: [["cargo-clippy"]]

RUST_CLIPPY: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_CLI_EXECUTABLE RUST_CLIPPY_CLI_EXECUTABLE items
Type: string

root RUST_CLIPPY_CLI_LINT_MODE

RUST_CLIPPY: CLI lint mode

Type: enum (of string) Default: "project"

RUST_CLIPPY: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS

RUST_CLIPPY: Custom remove arguments

Type: array of string or string

RUST_CLIPPY: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS items
Type: string

root RUST_CLIPPY_CONFIG_FILE

RUST_CLIPPY: Custom config file name

Type: string Default: ".clippy.toml"

RUST_CLIPPY: User custom config file name if different from default

root RUST_CLIPPY_DISABLE_ERRORS

RUST_CLIPPY: Disable errors

Type: boolean Default: false

RUSTCLIPPY: If true, RUSTCLIPPY doesn't make MegaLinter fail even if errors are found

root RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN

RUST_CLIPPY: Maximum number of errors allowed

Type: number Default: 0

RUSTCLIPPY: If the number of errors found is less than this value, RUSTCLIPPY doesn't make MegaLinter fail

root RUST_CLIPPY_FILE_EXTENSIONS

RUST_CLIPPY: Matching files extensions

Type: array of string Default: [".rs"]

RUST_CLIPPY: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_FILE_EXTENSIONS RUST_CLIPPY_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root RUST_CLIPPY_FILE_NAMES_REGEX

RUST_CLIPPY: Matching file name regexes

Type: array of string Default: []

RUST_CLIPPY: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_FILE_NAMES_REGEX RUST_CLIPPY_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root RUST_CLIPPY_POST_COMMANDS

RUST_CLIPPY: Post-run commands

Type: array

RUSTCLIPPY: Define bash commands to run after running RUSTCLIPPY

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_POST_COMMANDS Command

Command

Type: object

Command information

root RUST_CLIPPY_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUST_CLIPPY_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUST_CLIPPY_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUST_CLIPPY_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_POST_COMMANDS Command output_variables output_variables items
Type: string

root RUST_CLIPPY_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUST_CLIPPY_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUST_CLIPPY_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUST_CLIPPY_PRE_COMMANDS

RUST_CLIPPY: Pre-run commands

Type: array

RUSTCLIPPY: Define bash commands to run before running RUSTCLIPPY

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_PRE_COMMANDS Command

Command

Type: object

Command information

root RUST_CLIPPY_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUST_CLIPPY_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUST_CLIPPY_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUST_CLIPPY_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RUST_CLIPPY_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUST_CLIPPY_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUST_CLIPPY_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUST_CLIPPY_RULES_PATH

RUST_CLIPPY: Custom config file path

Type: string

RUST_CLIPPY: Path where to find linter configuration file

root RUST_CLIPPY_UNSECURED_ENV_VARIABLES

RUST_CLIPPY: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RUST_CLIPPY and its pre/post commands

 No Additional Items

Each item of this array must be:

root RUST_CLIPPY_UNSECURED_ENV_VARIABLES RUST_CLIPPY_UNSECURED_ENV_VARIABLES items
Type: string

root RUST_FILTER_REGEX_EXCLUDE

Excluding regex filter for RUST descriptor

Type: string

RUST: Custom regex excluding filter: files matching this regex will NOT be linted

root RUST_FILTER_REGEX_INCLUDE

Including regex filter for RUST descriptor

Type: string

RUST: Custom regex including filter: only files matching this regex will be linted

root RUST_POST_COMMANDS

Post commands for RUST descriptor

Type: array

RUST: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root RUST_POST_COMMANDS Command

Command

Type: object

Command information

root RUST_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUST_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUST_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUST_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUST_POST_COMMANDS Command output_variables output_variables items
Type: string

root RUST_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUST_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUST_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root RUST_PRE_COMMANDS

Pre commands for RUST descriptor

Type: array

RUST: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root RUST_PRE_COMMANDS Command

Command

Type: object

Command information

root RUST_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root RUST_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root RUST_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root RUST_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root RUST_PRE_COMMANDS Command output_variables output_variables items
Type: string

root RUST_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root RUST_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root RUST_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root R_FILTER_REGEX_EXCLUDE

Excluding regex filter for R descriptor

Type: string

R: Custom regex excluding filter: files matching this regex will NOT be linted

root R_FILTER_REGEX_INCLUDE

Including regex filter for R descriptor

Type: string

R: Custom regex including filter: only files matching this regex will be linted

root R_LINTR_ARGUMENTS

R_LINTR: Custom arguments

Type: array of string or string

R_LINTR: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root R_LINTR_ARGUMENTS R_LINTR_ARGUMENTS items
Type: string

root R_LINTR_CLI_EXECUTABLE

R_LINTR: CLI Executable

Type: array of string Default: [["lintr"]]

R_LINTR: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root R_LINTR_CLI_EXECUTABLE R_LINTR_CLI_EXECUTABLE items
Type: string

root R_LINTR_CLI_LINT_MODE

R_LINTR: CLI lint mode

Type: enum (of string) Default: "file"

R_LINTR: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root R_LINTR_COMMAND_REMOVE_ARGUMENTS

R_LINTR: Custom remove arguments

Type: array of string or string

R_LINTR: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root R_LINTR_COMMAND_REMOVE_ARGUMENTS R_LINTR_COMMAND_REMOVE_ARGUMENTS items
Type: string

root R_LINTR_CONFIG_FILE

R_LINTR: Custom config file name

Type: string Default: ".lintr"

R_LINTR: User custom config file name if different from default

root R_LINTR_DISABLE_ERRORS

R_LINTR: Disable errors

Type: boolean Default: false

RLINTR: If true, RLINTR doesn't make MegaLinter fail even if errors are found

root R_LINTR_DISABLE_ERRORS_IF_LESS_THAN

R_LINTR: Maximum number of errors allowed

Type: number Default: 0

RLINTR: If the number of errors found is less than this value, RLINTR doesn't make MegaLinter fail

root R_LINTR_FILE_EXTENSIONS

R_LINTR: Matching files extensions

Type: array of string Default: [".r", ".R", ".Rmd", ".RMD"]

R_LINTR: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root R_LINTR_FILE_EXTENSIONS R_LINTR_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root R_LINTR_FILE_NAMES_REGEX

R_LINTR: Matching file name regexes

Type: array of string Default: []

R_LINTR: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root R_LINTR_FILE_NAMES_REGEX R_LINTR_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root R_LINTR_FILTER_REGEX_EXCLUDE

R_LINTR: Excluding Regex

Type: string

R_LINTR: Custom regex excluding filter: files matching this regex will NOT be linted

root R_LINTR_FILTER_REGEX_INCLUDE

R_LINTR: Including Regex

Type: string

R_LINTR: Custom regex including filter: only files matching this regex will be linted

root R_LINTR_POST_COMMANDS

R_LINTR: Post-run commands

Type: array

RLINTR: Define bash commands to run after running RLINTR

 No Additional Items

Each item of this array must be:

root R_LINTR_POST_COMMANDS Command

Command

Type: object

Command information

root R_LINTR_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root R_LINTR_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root R_LINTR_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root R_LINTR_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root R_LINTR_POST_COMMANDS Command output_variables output_variables items
Type: string

root R_LINTR_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root R_LINTR_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root R_LINTR_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root R_LINTR_PRE_COMMANDS

R_LINTR: Pre-run commands

Type: array

RLINTR: Define bash commands to run before running RLINTR

 No Additional Items

Each item of this array must be:

root R_LINTR_PRE_COMMANDS Command

Command

Type: object

Command information

root R_LINTR_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root R_LINTR_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root R_LINTR_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root R_LINTR_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root R_LINTR_PRE_COMMANDS Command output_variables output_variables items
Type: string

root R_LINTR_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root R_LINTR_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root R_LINTR_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root R_LINTR_RULES_PATH

R_LINTR: Custom config file path

Type: string

R_LINTR: Path where to find linter configuration file

root R_LINTR_UNSECURED_ENV_VARIABLES

R_LINTR: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling R_LINTR and its pre/post commands

 No Additional Items

Each item of this array must be:

root R_LINTR_UNSECURED_ENV_VARIABLES R_LINTR_UNSECURED_ENV_VARIABLES items
Type: string

root R_POST_COMMANDS

Post commands for R descriptor

Type: array

R: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root R_POST_COMMANDS Command

Command

Type: object

Command information

root R_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root R_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root R_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root R_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root R_POST_COMMANDS Command output_variables output_variables items
Type: string

root R_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root R_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root R_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root R_PRE_COMMANDS

Pre commands for R descriptor

Type: array

R: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root R_PRE_COMMANDS Command

Command

Type: object

Command information

root R_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root R_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root R_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root R_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root R_PRE_COMMANDS Command output_variables output_variables items
Type: string

root R_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root R_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root R_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_APEX_ARGUMENTS

SALESFORCE_CODE_ANALYZER_APEX: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_APEX: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_ARGUMENTS SALESFORCE_CODE_ANALYZER_APEX_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_APEX_CLI_EXECUTABLE

SALESFORCE_CODE_ANALYZER_APEX: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_APEX: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_CLI_EXECUTABLE SALESFORCE_CODE_ANALYZER_APEX_CLI_EXECUTABLE items
Type: string

root SALESFORCE_CODE_ANALYZER_APEX_CLI_LINT_MODE

SALESFORCE_CODE_ANALYZER_APEX: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_CODE_ANALYZER_APEX_COMMAND_REMOVE_ARGUMENTS

SALESFORCE_CODE_ANALYZER_APEX: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_APEX: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_COMMAND_REMOVE_ARGUMENTS SALESFORCE_CODE_ANALYZER_APEX_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_APEX_CONFIG_FILE

SALESFORCE_CODE_ANALYZER_APEX: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_APEX: User custom config file name if different from default

root SALESFORCE_CODE_ANALYZER_APEX_DIRECTORY

SALESFORCE_CODE_ANALYZER_APEX: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_CODE_ANALYZER_APEX_DISABLE_ERRORS

SALESFORCE_CODE_ANALYZER_APEX: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERAPEX: If true, SALESFORCECODEANALYZERAPEX doesn't make MegaLinter fail even if errors are found

root SALESFORCE_CODE_ANALYZER_APEX_DISABLE_ERRORS_IF_LESS_THAN

SALESFORCE_CODE_ANALYZER_APEX: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERAPEX: If the number of errors found is less than this value, SALESFORCECODEANALYZERAPEX doesn't make MegaLinter fail

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS

SALESFORCE_CODE_ANALYZER_APEX: Post-run commands

Type: array

SALESFORCECODEANALYZERAPEX: Define bash commands to run after running SALESFORCECODEANALYZERAPEX

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS

SALESFORCE_CODE_ANALYZER_APEX: Pre-run commands

Type: array

SALESFORCECODEANALYZERAPEX: Define bash commands to run before running SALESFORCECODEANALYZERAPEX

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_APEX_RULES_PATH

SALESFORCE_CODE_ANALYZER_APEX: Custom config file path

Type: string

SALESFORCECODEANALYZER_APEX: Path where to find linter configuration file

root SALESFORCE_CODE_ANALYZER_APEX_UNSECURED_ENV_VARIABLES

SALESFORCE_CODE_ANALYZER_APEX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_APEX and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_APEX_UNSECURED_ENV_VARIABLES SALESFORCE_CODE_ANALYZER_APEX_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_ARGUMENTS

SALESFORCE_CODE_ANALYZER_AURA: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_AURA: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_ARGUMENTS SALESFORCE_CODE_ANALYZER_AURA_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_CLI_EXECUTABLE

SALESFORCE_CODE_ANALYZER_AURA: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_AURA: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_CLI_EXECUTABLE SALESFORCE_CODE_ANALYZER_AURA_CLI_EXECUTABLE items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_CLI_LINT_MODE

SALESFORCE_CODE_ANALYZER_AURA: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_CODE_ANALYZER_AURA_COMMAND_REMOVE_ARGUMENTS

SALESFORCE_CODE_ANALYZER_AURA: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_AURA: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_COMMAND_REMOVE_ARGUMENTS SALESFORCE_CODE_ANALYZER_AURA_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_CONFIG_FILE

SALESFORCE_CODE_ANALYZER_AURA: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_AURA: User custom config file name if different from default

root SALESFORCE_CODE_ANALYZER_AURA_DIRECTORY

SALESFORCE_CODE_ANALYZER_AURA: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_CODE_ANALYZER_AURA_DISABLE_ERRORS

SALESFORCE_CODE_ANALYZER_AURA: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERAURA: If true, SALESFORCECODEANALYZERAURA doesn't make MegaLinter fail even if errors are found

root SALESFORCE_CODE_ANALYZER_AURA_DISABLE_ERRORS_IF_LESS_THAN

SALESFORCE_CODE_ANALYZER_AURA: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERAURA: If the number of errors found is less than this value, SALESFORCECODEANALYZERAURA doesn't make MegaLinter fail

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS

SALESFORCE_CODE_ANALYZER_AURA: Post-run commands

Type: array

SALESFORCECODEANALYZERAURA: Define bash commands to run after running SALESFORCECODEANALYZERAURA

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS

SALESFORCE_CODE_ANALYZER_AURA: Pre-run commands

Type: array

SALESFORCECODEANALYZERAURA: Define bash commands to run before running SALESFORCECODEANALYZERAURA

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_AURA_RULES_PATH

SALESFORCE_CODE_ANALYZER_AURA: Custom config file path

Type: string

SALESFORCECODEANALYZER_AURA: Path where to find linter configuration file

root SALESFORCE_CODE_ANALYZER_AURA_UNSECURED_ENV_VARIABLES

SALESFORCE_CODE_ANALYZER_AURA: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_AURA and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_AURA_UNSECURED_ENV_VARIABLES SALESFORCE_CODE_ANALYZER_AURA_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_ARGUMENTS

SALESFORCE_CODE_ANALYZER_LWC: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_LWC: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_ARGUMENTS SALESFORCE_CODE_ANALYZER_LWC_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_CLI_EXECUTABLE

SALESFORCE_CODE_ANALYZER_LWC: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_LWC: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_CLI_EXECUTABLE SALESFORCE_CODE_ANALYZER_LWC_CLI_EXECUTABLE items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_CLI_LINT_MODE

SALESFORCE_CODE_ANALYZER_LWC: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_CODE_ANALYZER_LWC_COMMAND_REMOVE_ARGUMENTS

SALESFORCE_CODE_ANALYZER_LWC: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_LWC: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_COMMAND_REMOVE_ARGUMENTS SALESFORCE_CODE_ANALYZER_LWC_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_CONFIG_FILE

SALESFORCE_CODE_ANALYZER_LWC: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_LWC: User custom config file name if different from default

root SALESFORCE_CODE_ANALYZER_LWC_DIRECTORY

SALESFORCE_CODE_ANALYZER_LWC: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_CODE_ANALYZER_LWC_DISABLE_ERRORS

SALESFORCE_CODE_ANALYZER_LWC: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERLWC: If true, SALESFORCECODEANALYZERLWC doesn't make MegaLinter fail even if errors are found

root SALESFORCE_CODE_ANALYZER_LWC_DISABLE_ERRORS_IF_LESS_THAN

SALESFORCE_CODE_ANALYZER_LWC: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERLWC: If the number of errors found is less than this value, SALESFORCECODEANALYZERLWC doesn't make MegaLinter fail

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS

SALESFORCE_CODE_ANALYZER_LWC: Post-run commands

Type: array

SALESFORCECODEANALYZERLWC: Define bash commands to run after running SALESFORCECODEANALYZERLWC

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS

SALESFORCE_CODE_ANALYZER_LWC: Pre-run commands

Type: array

SALESFORCECODEANALYZERLWC: Define bash commands to run before running SALESFORCECODEANALYZERLWC

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_CODE_ANALYZER_LWC_RULES_PATH

SALESFORCE_CODE_ANALYZER_LWC: Custom config file path

Type: string

SALESFORCECODEANALYZER_LWC: Path where to find linter configuration file

root SALESFORCE_CODE_ANALYZER_LWC_UNSECURED_ENV_VARIABLES

SALESFORCE_CODE_ANALYZER_LWC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_LWC and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_CODE_ANALYZER_LWC_UNSECURED_ENV_VARIABLES SALESFORCE_CODE_ANALYZER_LWC_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_DIRECTORY

SALESFORCE_DIRECTORY: Directory containing SALESFORCE files

Type: string Default: "force-app"

root SALESFORCE_FILTER_REGEX_EXCLUDE

Excluding regex filter for SALESFORCE descriptor

Type: string

SALESFORCE: Custom regex excluding filter: files matching this regex will NOT be linted

root SALESFORCE_FILTER_REGEX_INCLUDE

Including regex filter for SALESFORCE descriptor

Type: string

SALESFORCE: Custom regex including filter: only files matching this regex will be linted

root SALESFORCE_LIGHTNING_FLOW_SCANNER_ARGUMENTS

SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom arguments

Type: array of string or string

SALESFORCELIGHTNINGFLOW_SCANNER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_ARGUMENTS SALESFORCE_LIGHTNING_FLOW_SCANNER_ARGUMENTS items
Type: string

root SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_EXECUTABLE

SALESFORCE_LIGHTNING_FLOW_SCANNER: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCELIGHTNINGFLOW_SCANNER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_EXECUTABLE SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_EXECUTABLE items
Type: string

root SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_LINT_MODE

SALESFORCE_LIGHTNING_FLOW_SCANNER: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCELIGHTNINGFLOW_SCANNER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_LIGHTNING_FLOW_SCANNER_COMMAND_REMOVE_ARGUMENTS

SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom remove arguments

Type: array of string or string

SALESFORCELIGHTNINGFLOW_SCANNER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_COMMAND_REMOVE_ARGUMENTS SALESFORCE_LIGHTNING_FLOW_SCANNER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_LIGHTNING_FLOW_SCANNER_CONFIG_FILE

SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom config file name

Type: string Default: ".flow-scanner.json"

SALESFORCELIGHTNINGFLOW_SCANNER: User custom config file name if different from default

root SALESFORCE_LIGHTNING_FLOW_SCANNER_DIRECTORY

SALESFORCE_LIGHTNING_FLOW_SCANNER: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_LIGHTNING_FLOW_SCANNER_DISABLE_ERRORS

SALESFORCE_LIGHTNING_FLOW_SCANNER: Disable errors

Type: boolean Default: false

SALESFORCELIGHTNINGFLOWSCANNER: If true, SALESFORCELIGHTNINGFLOWSCANNER doesn't make MegaLinter fail even if errors are found

root SALESFORCE_LIGHTNING_FLOW_SCANNER_DISABLE_ERRORS_IF_LESS_THAN

SALESFORCE_LIGHTNING_FLOW_SCANNER: Maximum number of errors allowed

Type: number Default: 0

SALESFORCELIGHTNINGFLOWSCANNER: If the number of errors found is less than this value, SALESFORCELIGHTNINGFLOWSCANNER doesn't make MegaLinter fail

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS

SALESFORCE_LIGHTNING_FLOW_SCANNER: Post-run commands

Type: array

SALESFORCELIGHTNINGFLOWSCANNER: Define bash commands to run after running SALESFORCELIGHTNINGFLOWSCANNER

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS

SALESFORCE_LIGHTNING_FLOW_SCANNER: Pre-run commands

Type: array

SALESFORCELIGHTNINGFLOWSCANNER: Define bash commands to run before running SALESFORCELIGHTNINGFLOWSCANNER

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_LIGHTNING_FLOW_SCANNER_RULES_PATH

SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom config file path

Type: string

SALESFORCELIGHTNINGFLOW_SCANNER: Path where to find linter configuration file

root SALESFORCE_LIGHTNING_FLOW_SCANNER_UNSECURED_ENV_VARIABLES

SALESFORCE_LIGHTNING_FLOW_SCANNER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCELIGHTNINGFLOW_SCANNER and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_LIGHTNING_FLOW_SCANNER_UNSECURED_ENV_VARIABLES SALESFORCE_LIGHTNING_FLOW_SCANNER_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_POST_COMMANDS

Post commands for SALESFORCE descriptor

Type: array

SALESFORCE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SALESFORCE_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_PRE_COMMANDS

Pre commands for SALESFORCE descriptor

Type: array

SALESFORCE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SALESFORCE_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_APEX: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_APEX: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_CLI_LINT_MODE

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_APEX: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom config file name

Type: string Default: "apex-pmd-ruleset.xml"

SALESFORCESFDXSCANNER_APEX: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERAPEX: If true, SALESFORCESFDXSCANNERAPEX doesn't make MegaLinter fail even if errors are found

root SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERAPEX: If the number of errors found is less than this value, SALESFORCESFDXSCANNERAPEX doesn't make MegaLinter fail

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS

SALESFORCE_SFDX_SCANNER_APEX: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAPEX: Define bash commands to run after running SALESFORCESFDXSCANNERAPEX

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS

SALESFORCE_SFDX_SCANNER_APEX: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAPEX: Define bash commands to run before running SALESFORCESFDXSCANNERAPEX

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom config file path

Type: string

SALESFORCESFDXSCANNER_APEX: Path where to find linter configuration file

root SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_APEX and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_SFDX_SCANNER_ARGUMENTS

SALESFORCE_SFDX_SCANNER: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_ARGUMENTS SALESFORCE_SFDX_SCANNER_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_AURA: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_AURA: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_CLI_LINT_MODE

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_AURA: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom config file name

Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_AURA: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERAURA: If true, SALESFORCESFDXSCANNERAURA doesn't make MegaLinter fail even if errors are found

root SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERAURA: If the number of errors found is less than this value, SALESFORCESFDXSCANNERAURA doesn't make MegaLinter fail

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS

SALESFORCE_SFDX_SCANNER_AURA: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAURA: Define bash commands to run after running SALESFORCESFDXSCANNERAURA

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS

SALESFORCE_SFDX_SCANNER_AURA: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAURA: Define bash commands to run before running SALESFORCESFDXSCANNERAURA

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom config file path

Type: string

SALESFORCESFDXSCANNER_AURA: Path where to find linter configuration file

root SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_AURA and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES items
Type: string

root SALESFORCE_SFDX_SCANNER_DIRECTORY

SALESFORCE_SFDX_SCANNER: Directory containing SALESFORCE files

Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS

SALESFORCE_SFDX_SCANNER: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

root SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS_IF_LESS_THAN

SALESFORCE_SFDX_SCANNER: Maximum number of errors allowed

Type: number Default: 0

root SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS

SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS items
Type: string

root SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX

SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SALESFORCE_SFDX_SCANNER_FILTER_REGEX_EXCLUDE

SALESFORCE_SFDX_SCANNER: Excluding Regex

Type: string

root SALESFORCE_SFDX_SCANNER_FILTER_REGEX_INCLUDE

SALESFORCE_SFDX_SCANNER: Including Regex

Type: string

root SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_LWC: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_LWC: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_CLI_LINT_MODE

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_LWC: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom config file name

Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_LWC: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

root SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERLWC: If true, SALESFORCESFDXSCANNERLWC doesn't make MegaLinter fail even if errors are found

root SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERLWC: If the number of errors found is less than this value, SALESFORCESFDXSCANNERLWC doesn't make MegaLinter fail

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS

SALESFORCE_SFDX_SCANNER_LWC: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERLWC: Define bash commands to run after running SALESFORCESFDXSCANNERLWC

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS

SALESFORCE_SFDX_SCANNER_LWC: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERLWC: Define bash commands to run before running SALESFORCESFDXSCANNERLWC

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command

Command

Type: object

Command information

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom config file path

Type: string

SALESFORCESFDXSCANNER_LWC: Path where to find linter configuration file

root SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_LWC and its pre/post commands

 No Additional Items

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES items
Type: string

root SARIF_REPORTER

Activate SARIF reporter

Type: boolean Default: false

Generate SARIF reports that can be used to display issues directly in GitHub UI

root SARIF_REPORTER_FILE_NAME

SARIF report file name

Type: string Default: "mega-linter-report.sarif"

Override SARIF output file name

root SARIF_REPORTER_LINTERS

SARIF enabled linters

Type: array

If SARIFREPORTERLINTERS is set, only the linters in the list will output SARIF

 No Additional Items

Each item of this array must be:

root SARIF_REPORTER_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_SCSSLINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

root SCALA_FILTER_REGEX_EXCLUDE

Excluding regex filter for SCALA descriptor

Type: string

SCALA: Custom regex excluding filter: files matching this regex will NOT be linted

root SCALA_FILTER_REGEX_INCLUDE

Including regex filter for SCALA descriptor

Type: string

SCALA: Custom regex including filter: only files matching this regex will be linted

root SCALA_POST_COMMANDS

Post commands for SCALA descriptor

Type: array

SCALA: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SCALA_POST_COMMANDS Command

Command

Type: object

Command information

root SCALA_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SCALA_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SCALA_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SCALA_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SCALA_POST_COMMANDS Command output_variables output_variables items
Type: string

root SCALA_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SCALA_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SCALA_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SCALA_PRE_COMMANDS

Pre commands for SCALA descriptor

Type: array

SCALA: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SCALA_PRE_COMMANDS Command

Command

Type: object

Command information

root SCALA_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SCALA_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SCALA_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SCALA_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SCALA_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SCALA_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SCALA_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SCALA_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SCALA_SCALAFIX_ARGUMENTS

SCALA_SCALAFIX: Custom arguments

Type: array of string or string

SCALA_SCALAFIX: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_ARGUMENTS SCALA_SCALAFIX_ARGUMENTS items
Type: string

root SCALA_SCALAFIX_CLI_EXECUTABLE

SCALA_SCALAFIX: CLI Executable

Type: array of string Default: [["scalafix"]]

SCALA_SCALAFIX: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_CLI_EXECUTABLE SCALA_SCALAFIX_CLI_EXECUTABLE items
Type: string

root SCALA_SCALAFIX_CLI_LINT_MODE

SCALA_SCALAFIX: CLI lint mode

Type: enum (of string) Default: "file"

SCALA_SCALAFIX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS

SCALA_SCALAFIX: Custom remove arguments

Type: array of string or string

SCALA_SCALAFIX: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SCALA_SCALAFIX_CONFIG_FILE

SCALA_SCALAFIX: Custom config file name

Type: string Default: ".scalafix.conf"

SCALA_SCALAFIX: User custom config file name if different from default

root SCALA_SCALAFIX_DISABLE_ERRORS

SCALA_SCALAFIX: Disable errors

Type: boolean Default: false

SCALASCALAFIX: If true, SCALASCALAFIX doesn't make MegaLinter fail even if errors are found

root SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN

SCALA_SCALAFIX: Maximum number of errors allowed

Type: number Default: 0

SCALASCALAFIX: If the number of errors found is less than this value, SCALASCALAFIX doesn't make MegaLinter fail

root SCALA_SCALAFIX_FILE_EXTENSIONS

SCALA_SCALAFIX: Matching files extensions

Type: array of string Default: [".scala"]

SCALA_SCALAFIX: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_FILE_EXTENSIONS SCALA_SCALAFIX_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SCALA_SCALAFIX_FILE_NAMES_REGEX

SCALA_SCALAFIX: Matching file name regexes

Type: array of string Default: []

SCALA_SCALAFIX: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_FILE_NAMES_REGEX SCALA_SCALAFIX_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE

SCALA_SCALAFIX: Excluding Regex

Type: string

SCALA_SCALAFIX: Custom regex excluding filter: files matching this regex will NOT be linted

root SCALA_SCALAFIX_FILTER_REGEX_INCLUDE

SCALA_SCALAFIX: Including Regex

Type: string

SCALA_SCALAFIX: Custom regex including filter: only files matching this regex will be linted

root SCALA_SCALAFIX_POST_COMMANDS

SCALA_SCALAFIX: Post-run commands

Type: array

SCALASCALAFIX: Define bash commands to run after running SCALASCALAFIX

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_POST_COMMANDS Command

Command

Type: object

Command information

root SCALA_SCALAFIX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SCALA_SCALAFIX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SCALA_SCALAFIX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SCALA_SCALAFIX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_POST_COMMANDS Command output_variables output_variables items
Type: string

root SCALA_SCALAFIX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SCALA_SCALAFIX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SCALA_SCALAFIX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SCALA_SCALAFIX_PRE_COMMANDS

SCALA_SCALAFIX: Pre-run commands

Type: array

SCALASCALAFIX: Define bash commands to run before running SCALASCALAFIX

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_PRE_COMMANDS Command

Command

Type: object

Command information

root SCALA_SCALAFIX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SCALA_SCALAFIX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SCALA_SCALAFIX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SCALA_SCALAFIX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SCALA_SCALAFIX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SCALA_SCALAFIX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SCALA_SCALAFIX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SCALA_SCALAFIX_RULES_PATH

SCALA_SCALAFIX: Custom config file path

Type: string

SCALA_SCALAFIX: Path where to find linter configuration file

root SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES

SCALA_SCALAFIX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SCALA_SCALAFIX and its pre/post commands

 No Additional Items

Each item of this array must be:

root SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES items
Type: string

root SECURED_ENV_VARIABLES

Additional secured environment variables

Type: array of string Default: []

List of additional secured environment variables to hide when calling linters. Can contain string or regex patterns.

 No Additional Items

Each item of this array must be:

root SECURED_ENV_VARIABLES SECURED_ENV_VARIABLES items
Type: string

root SECURED_ENV_VARIABLES_DEFAULT

Default secured environment variables

Type: array of string Default: ["PAT", "GIT_AUTHORIZATION_BEARER", "GITLAB_CUSTOM_CERTIFICATE", "(USERNAME)", "(PASSWORD)", "(TOKEN)", "(SFDX_CLIENT_ID_.*)", "(SFDX_CLIENT_KEY_.*)"]

List of default secured environment variables that will be hidden when calling linters. Can contain string or regex patterns. This should generally not be overridden, use (additional) SECUREDENVVARIABLES instead to add more variables to the list.

 No Additional Items

Each item of this array must be:

root SECURED_ENV_VARIABLES_DEFAULT SECURED_ENV_VARIABLES_DEFAULT items
Type: string

root SHOW_ELAPSED_TIME

Show elapsed time

Type: boolean Default: false

Displays elapsed time for each linter in reports

root SHOW_SKIPPED_LINTERS

Show skipped Linters

Type: boolean Default: true

Displays all linters that mega-linter could run but didn't

root SKIP_CLI_LINT_MODES

List of CLI lint modes to skip

Type: array of enum (of string)

Comma-separated list of clilintmodes. To use if you want to skip linters with some CLI lint modes (ex: "file,project"). Available values: file,clilintmode,project

 No Additional Items

Each item of this array must be:

root SKIP_CLI_LINT_MODES SKIP_CLI_LINT_MODES items
Type: enum (of string)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SNAKEMAKE_FILTER_REGEX_EXCLUDE

Excluding regex filter for SNAKEMAKE descriptor

Type: string

SNAKEMAKE: Custom regex excluding filter: files matching this regex will NOT be linted

root SNAKEMAKE_FILTER_REGEX_INCLUDE

Including regex filter for SNAKEMAKE descriptor

Type: string

SNAKEMAKE: Custom regex including filter: only files matching this regex will be linted

root SNAKEMAKE_LINT_ARGUMENTS

SNAKEMAKE_LINT: Custom arguments

Type: array of string or string

SNAKEMAKE_LINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_ARGUMENTS SNAKEMAKE_LINT_ARGUMENTS items
Type: string

root SNAKEMAKE_LINT_CLI_EXECUTABLE

SNAKEMAKE_LINT: CLI Executable

Type: array of string Default: [["snakemake"]]

SNAKEMAKE_LINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_CLI_EXECUTABLE SNAKEMAKE_LINT_CLI_EXECUTABLE items
Type: string

root SNAKEMAKE_LINT_CLI_LINT_MODE

SNAKEMAKE_LINT: CLI lint mode

Type: enum (of string) Default: "file"

SNAKEMAKE_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS

SNAKEMAKE_LINT: Custom remove arguments

Type: array of string or string

SNAKEMAKE_LINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SNAKEMAKE_LINT_DISABLE_ERRORS

SNAKEMAKE_LINT: Disable errors

Type: boolean Default: false

SNAKEMAKELINT: If true, SNAKEMAKELINT doesn't make MegaLinter fail even if errors are found

root SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN

SNAKEMAKE_LINT: Maximum number of errors allowed

Type: number Default: 0

SNAKEMAKELINT: If the number of errors found is less than this value, SNAKEMAKELINT doesn't make MegaLinter fail

root SNAKEMAKE_LINT_FILE_EXTENSIONS

SNAKEMAKE_LINT: Matching files extensions

Type: array of string Default: [".smk"]

SNAKEMAKE_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_FILE_EXTENSIONS SNAKEMAKE_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SNAKEMAKE_LINT_FILE_NAMES_REGEX

SNAKEMAKE_LINT: Matching file name regexes

Type: array of string Default: ["Snakefile"]

SNAKEMAKE_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_FILE_NAMES_REGEX SNAKEMAKE_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE

SNAKEMAKE_LINT: Excluding Regex

Type: string

SNAKEMAKE_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

root SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE

SNAKEMAKE_LINT: Including Regex

Type: string

SNAKEMAKE_LINT: Custom regex including filter: only files matching this regex will be linted

root SNAKEMAKE_LINT_POST_COMMANDS

SNAKEMAKE_LINT: Post-run commands

Type: array

SNAKEMAKELINT: Define bash commands to run after running SNAKEMAKELINT

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_LINT_PRE_COMMANDS

SNAKEMAKE_LINT: Pre-run commands

Type: array

SNAKEMAKELINT: Define bash commands to run before running SNAKEMAKELINT

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES

SNAKEMAKE_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SNAKEMAKE_LINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root SNAKEMAKE_POST_COMMANDS

Post commands for SNAKEMAKE descriptor

Type: array

SNAKEMAKE: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_POST_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_POST_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_PRE_COMMANDS

Pre commands for SNAKEMAKE descriptor

Type: array

SNAKEMAKE: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_PRE_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_SNAKEFMT_ARGUMENTS

SNAKEMAKE_SNAKEFMT: Custom arguments

Type: array of string or string

SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_ARGUMENTS SNAKEMAKE_SNAKEFMT_ARGUMENTS items
Type: string

root SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE

SNAKEMAKE_SNAKEFMT: CLI Executable

Type: array of string Default: [["snakefmt"]]

SNAKEMAKE_SNAKEFMT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE items
Type: string

root SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE

SNAKEMAKE_SNAKEFMT: CLI lint mode

Type: enum (of string) Default: "file"

SNAKEMAKE_SNAKEFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS

SNAKEMAKE_SNAKEFMT: Custom remove arguments

Type: array of string or string

SNAKEMAKE_SNAKEFMT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SNAKEMAKE_SNAKEFMT_CONFIG_FILE

SNAKEMAKE_SNAKEFMT: Custom config file name

Type: string Default: ".snakefmt.toml"

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

root SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS

SNAKEMAKE_SNAKEFMT: Disable errors

Type: boolean Default: false

SNAKEMAKESNAKEFMT: If true, SNAKEMAKESNAKEFMT doesn't make MegaLinter fail even if errors are found

root SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN

SNAKEMAKE_SNAKEFMT: Maximum number of errors allowed

Type: number Default: 0

SNAKEMAKESNAKEFMT: If the number of errors found is less than this value, SNAKEMAKESNAKEFMT doesn't make MegaLinter fail

root SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS

SNAKEMAKE_SNAKEFMT: Matching files extensions

Type: array of string Default: [".smk"]

SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX

SNAKEMAKE_SNAKEFMT: Matching file name regexes

Type: array of string Default: ["Snakefile"]

SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE

SNAKEMAKE_SNAKEFMT: Excluding Regex

Type: string

SNAKEMAKE_SNAKEFMT: Custom regex excluding filter: files matching this regex will NOT be linted

root SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE

SNAKEMAKE_SNAKEFMT: Including Regex

Type: string

SNAKEMAKE_SNAKEFMT: Custom regex including filter: only files matching this regex will be linted

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS

SNAKEMAKE_SNAKEFMT: Post-run commands

Type: array

SNAKEMAKESNAKEFMT: Define bash commands to run after running SNAKEMAKESNAKEFMT

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS

SNAKEMAKE_SNAKEFMT: Pre-run commands

Type: array

SNAKEMAKESNAKEFMT: Define bash commands to run before running SNAKEMAKESNAKEFMT

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command

Command

Type: object

Command information

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SNAKEMAKE_SNAKEFMT_RULES_PATH

SNAKEMAKE_SNAKEFMT: Custom config file path

Type: string

SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file

root SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES

SNAKEMAKE_SNAKEFMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SNAKEMAKE_SNAKEFMT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES items
Type: string

root SPELL_CODESPELL_ARGUMENTS

SPELL_CODESPELL: Custom arguments

Type: array of string or string

SPELL_CODESPELL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_ARGUMENTS SPELL_CODESPELL_ARGUMENTS items
Type: string

root SPELL_CODESPELL_CLI_EXECUTABLE

SPELL_CODESPELL: CLI Executable

Type: array of string Default: [["codespell"]]

SPELL_CODESPELL: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_CLI_EXECUTABLE SPELL_CODESPELL_CLI_EXECUTABLE items
Type: string

root SPELL_CODESPELL_CLI_LINT_MODE

SPELL_CODESPELL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_CODESPELL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_CODESPELL_COMMAND_REMOVE_ARGUMENTS

SPELL_CODESPELL: Custom remove arguments

Type: array of string or string

SPELL_CODESPELL: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_COMMAND_REMOVE_ARGUMENTS SPELL_CODESPELL_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SPELL_CODESPELL_CONFIG_FILE

SPELL_CODESPELL: Custom config file name

Type: string Default: ".codespellrc"

SPELL_CODESPELL: User custom config file name if different from default

root SPELL_CODESPELL_DISABLE_ERRORS

SPELL_CODESPELL: Disable errors

Type: boolean Default: false

SPELLCODESPELL: If true, SPELLCODESPELL doesn't make MegaLinter fail even if errors are found

root SPELL_CODESPELL_DISABLE_ERRORS_IF_LESS_THAN

SPELL_CODESPELL: Maximum number of errors allowed

Type: number Default: 0

SPELLCODESPELL: If the number of errors found is less than this value, SPELLCODESPELL doesn't make MegaLinter fail

root SPELL_CODESPELL_FILE_EXTENSIONS

SPELL_CODESPELL: Matching files extensions

Type: array of string Default: [".md", ".mdx", ".markdown", ".html", ".htm", ".rst", ".txt", ".json", ".jsonc", ".json5", ".yaml", ".yml"]

SPELL_CODESPELL: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_FILE_EXTENSIONS SPELL_CODESPELL_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SPELL_CODESPELL_FILE_NAMES_REGEX

SPELL_CODESPELL: Matching file name regexes

Type: array of string Default: []

SPELL_CODESPELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_FILE_NAMES_REGEX SPELL_CODESPELL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_CODESPELL_FILTER_REGEX_EXCLUDE

SPELL_CODESPELL: Excluding Regex

Type: string

SPELL_CODESPELL: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_CODESPELL_FILTER_REGEX_INCLUDE

SPELL_CODESPELL: Including Regex

Type: string

SPELL_CODESPELL: Custom regex including filter: only files matching this regex will be linted

root SPELL_CODESPELL_POST_COMMANDS

SPELL_CODESPELL: Post-run commands

Type: array

SPELLCODESPELL: Define bash commands to run after running SPELLCODESPELL

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_CODESPELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_CODESPELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_CODESPELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_CODESPELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_CODESPELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_CODESPELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_CODESPELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_CODESPELL_PRE_COMMANDS

SPELL_CODESPELL: Pre-run commands

Type: array

SPELLCODESPELL: Define bash commands to run before running SPELLCODESPELL

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_CODESPELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_CODESPELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_CODESPELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_CODESPELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_CODESPELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_CODESPELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_CODESPELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_CODESPELL_RULES_PATH

SPELL_CODESPELL: Custom config file path

Type: string

SPELL_CODESPELL: Path where to find linter configuration file

root SPELL_CODESPELL_UNSECURED_ENV_VARIABLES

SPELL_CODESPELL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_CODESPELL and its pre/post commands

 No Additional Items

Each item of this array must be:

root SPELL_CODESPELL_UNSECURED_ENV_VARIABLES SPELL_CODESPELL_UNSECURED_ENV_VARIABLES items
Type: string

root SPELL_CSPELL_ANALYZE_FILE_NAMES

SPELL_CSPELL: Analyze file names

Type: boolean Default: false

If set to true, MegaLinter will also send file names to cspell for analysis.

root SPELL_CSPELL_ARGUMENTS

SPELL_CSPELL: Custom arguments

Type: array of string or string

SPELL_CSPELL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_ARGUMENTS SPELL_CSPELL_ARGUMENTS items
Type: string

root SPELL_CSPELL_CLI_EXECUTABLE

SPELL_CSPELL: CLI Executable

Type: array of string Default: [["cspell"]]

SPELL_CSPELL: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_CLI_EXECUTABLE SPELL_CSPELL_CLI_EXECUTABLE items
Type: string

root SPELL_CSPELL_CLI_LINT_MODE

SPELL_CSPELL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_CSPELL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS

SPELL_CSPELL: Custom remove arguments

Type: array of string or string

SPELL_CSPELL: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SPELL_CSPELL_CONFIG_FILE

SPELL_CSPELL: Custom config file name

Type: string Default: ".cspell.json"

SPELL_CSPELL: User custom config file name if different from default

root SPELL_CSPELL_DISABLE_ERRORS

SPELL_CSPELL: Disable errors

Type: boolean Default: false

SPELLCSPELL: If true, SPELLCSPELL doesn't make MegaLinter fail even if errors are found

root SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN

SPELL_CSPELL: Maximum number of errors allowed

Type: number Default: 0

SPELLCSPELL: If the number of errors found is less than this value, SPELLCSPELL doesn't make MegaLinter fail

root SPELL_CSPELL_FILE_EXTENSIONS

SPELL_CSPELL: Matching files extensions

Type: array of string Default: []

SPELL_CSPELL: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_FILE_EXTENSIONS SPELL_CSPELL_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SPELL_CSPELL_FILE_NAMES_REGEX

SPELL_CSPELL: Matching file name regexes

Type: array of string Default: []

SPELL_CSPELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_FILE_NAMES_REGEX SPELL_CSPELL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_CSPELL_FILTER_REGEX_EXCLUDE

SPELL_CSPELL: Excluding Regex

Type: string

SPELL_CSPELL: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_CSPELL_FILTER_REGEX_INCLUDE

SPELL_CSPELL: Including Regex

Type: string

SPELL_CSPELL: Custom regex including filter: only files matching this regex will be linted

root SPELL_CSPELL_POST_COMMANDS

SPELL_CSPELL: Post-run commands

Type: array

SPELLCSPELL: Define bash commands to run after running SPELLCSPELL

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_CSPELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_CSPELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_CSPELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_CSPELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_CSPELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_CSPELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_CSPELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_CSPELL_PRE_COMMANDS

SPELL_CSPELL: Pre-run commands

Type: array

SPELLCSPELL: Define bash commands to run before running SPELLCSPELL

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_CSPELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_CSPELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_CSPELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_CSPELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_CSPELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_CSPELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_CSPELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_CSPELL_RULES_PATH

SPELL_CSPELL: Custom config file path

Type: string

SPELL_CSPELL: Path where to find linter configuration file

root SPELL_CSPELL_UNSECURED_ENV_VARIABLES

SPELL_CSPELL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands

 No Additional Items

Each item of this array must be:

root SPELL_CSPELL_UNSECURED_ENV_VARIABLES SPELL_CSPELL_UNSECURED_ENV_VARIABLES items
Type: string

root SPELL_FILTER_REGEX_EXCLUDE

Excluding regex filter for SPELL descriptor

Type: string

SPELL: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_FILTER_REGEX_INCLUDE

Including regex filter for SPELL descriptor

Type: string

SPELL: Custom regex including filter: only files matching this regex will be linted

root SPELL_LYCHEE_ARGUMENTS

SPELL_LYCHEE: Custom arguments

Type: array of string or string

SPELL_LYCHEE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_ARGUMENTS SPELL_LYCHEE_ARGUMENTS items
Type: string

root SPELL_LYCHEE_CLI_EXECUTABLE

SPELL_LYCHEE: CLI Executable

Type: array of string Default: [["lychee"]]

SPELL_LYCHEE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_CLI_EXECUTABLE SPELL_LYCHEE_CLI_EXECUTABLE items
Type: string

root SPELL_LYCHEE_CLI_LINT_MODE

SPELL_LYCHEE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_LYCHEE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS

SPELL_LYCHEE: Custom remove arguments

Type: array of string or string

SPELL_LYCHEE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SPELL_LYCHEE_CONFIG_FILE

SPELL_LYCHEE: Custom config file name

Type: string Default: "lychee.toml"

SPELL_LYCHEE: User custom config file name if different from default

root SPELL_LYCHEE_DISABLE_ERRORS

SPELL_LYCHEE: Disable errors

Type: boolean Default: false

SPELLLYCHEE: If true, SPELLLYCHEE doesn't make MegaLinter fail even if errors are found

root SPELL_LYCHEE_DISABLE_ERRORS_IF_LESS_THAN

SPELL_LYCHEE: Maximum number of errors allowed

Type: number Default: 0

SPELLLYCHEE: If the number of errors found is less than this value, SPELLLYCHEE doesn't make MegaLinter fail

root SPELL_LYCHEE_FILE_EXTENSIONS

SPELL_LYCHEE: Matching files extensions

Type: array of string Default: [".md", ".mdx", ".markdown", ".html", ".htm", ".rst", ".txt", ".json", ".jsonc", ".json5", ".yaml", ".yml"]

SPELL_LYCHEE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_FILE_EXTENSIONS SPELL_LYCHEE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SPELL_LYCHEE_FILE_NAMES_REGEX

SPELL_LYCHEE: Matching file name regexes

Type: array of string Default: []

SPELL_LYCHEE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_FILE_NAMES_REGEX SPELL_LYCHEE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_LYCHEE_FILTER_REGEX_EXCLUDE

SPELL_LYCHEE: Excluding Regex

Type: string

SPELL_LYCHEE: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_LYCHEE_FILTER_REGEX_INCLUDE

SPELL_LYCHEE: Including Regex

Type: string

SPELL_LYCHEE: Custom regex including filter: only files matching this regex will be linted

root SPELL_LYCHEE_POST_COMMANDS

SPELL_LYCHEE: Post-run commands

Type: array

SPELLLYCHEE: Define bash commands to run after running SPELLLYCHEE

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_LYCHEE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_LYCHEE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_LYCHEE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_LYCHEE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_LYCHEE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_LYCHEE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_LYCHEE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_LYCHEE_PRE_COMMANDS

SPELL_LYCHEE: Pre-run commands

Type: array

SPELLLYCHEE: Define bash commands to run before running SPELLLYCHEE

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_LYCHEE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_LYCHEE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_LYCHEE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_LYCHEE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_LYCHEE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_LYCHEE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_LYCHEE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_LYCHEE_RULES_PATH

SPELL_LYCHEE: Custom config file path

Type: string

SPELL_LYCHEE: Path where to find linter configuration file

root SPELL_LYCHEE_UNSECURED_ENV_VARIABLES

SPELL_LYCHEE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_LYCHEE and its pre/post commands

 No Additional Items

Each item of this array must be:

root SPELL_LYCHEE_UNSECURED_ENV_VARIABLES SPELL_LYCHEE_UNSECURED_ENV_VARIABLES items
Type: string

root SPELL_MISSPELL_ARGUMENTS

SPELL_MISSPELL: Custom arguments

Type: array of string or string

SPELL_MISSPELL: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_ARGUMENTS SPELL_MISSPELL_ARGUMENTS items
Type: string

root SPELL_MISSPELL_CLI_EXECUTABLE

SPELL_MISSPELL: CLI Executable

Type: array of string Default: [["misspell"]]
No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_CLI_EXECUTABLE SPELL_MISSPELL_CLI_EXECUTABLE items
Type: string

root SPELL_MISSPELL_CLI_LINT_MODE

SPELL_MISSPELL: Override default cli lint mode

Type: enum (of string) Default: "list_of_files"

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_MISSPELL_DISABLE_ERRORS

SPELL_MISSPELL: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN

SPELL_MISSPELL: Maximum number of errors allowed

Type: number Default: 0

root SPELL_MISSPELL_FILE_EXTENSIONS

SPELL_MISSPELL: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_FILE_EXTENSIONS SPELL_MISSPELL_FILE_EXTENSIONS items
Type: string

root SPELL_MISSPELL_FILE_NAMES_REGEX

SPELL_MISSPELL: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_FILE_NAMES_REGEX SPELL_MISSPELL_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_MISSPELL_FILTER_REGEX_EXCLUDE

SPELL_MISSPELL: Excluding Regex

Type: string

root SPELL_MISSPELL_FILTER_REGEX_INCLUDE

SPELL_MISSPELL: Including Regex

Type: string

root SPELL_MISSPELL_POST_COMMANDS

SPELL_MISSPELL: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_MISSPELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_MISSPELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_MISSPELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_MISSPELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_MISSPELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_MISSPELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_MISSPELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_MISSPELL_PRE_COMMANDS

SPELL_MISSPELL: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_MISSPELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_MISSPELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_MISSPELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_MISSPELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_MISSPELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_MISSPELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_MISSPELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_MISSPELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_POST_COMMANDS

Post commands for SPELL descriptor

Type: array

SPELL: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SPELL_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_PRE_COMMANDS

Pre commands for SPELL descriptor

Type: array

SPELL: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SPELL_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_PROSELINT_ARGUMENTS

SPELL_PROSELINT: Custom arguments

Type: array of string or string

SPELL_PROSELINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_ARGUMENTS SPELL_PROSELINT_ARGUMENTS items
Type: string

root SPELL_PROSELINT_CLI_EXECUTABLE

SPELL_PROSELINT: CLI Executable

Type: array of string Default: [["proselint"]]

SPELL_PROSELINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_CLI_EXECUTABLE SPELL_PROSELINT_CLI_EXECUTABLE items
Type: string

root SPELL_PROSELINT_CLI_LINT_MODE

SPELL_PROSELINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_PROSELINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS

SPELL_PROSELINT: Custom remove arguments

Type: array of string or string

SPELL_PROSELINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SPELL_PROSELINT_CONFIG_FILE

SPELL_PROSELINT: Custom config file name

Type: string Default: ".proselintrc"

SPELL_PROSELINT: User custom config file name if different from default

root SPELL_PROSELINT_DISABLE_ERRORS

SPELL_PROSELINT: Disable errors

Type: boolean Default: false

SPELLPROSELINT: If true, SPELLPROSELINT doesn't make MegaLinter fail even if errors are found

root SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN

SPELL_PROSELINT: Maximum number of errors allowed

Type: number Default: 0

SPELLPROSELINT: If the number of errors found is less than this value, SPELLPROSELINT doesn't make MegaLinter fail

root SPELL_PROSELINT_FILE_EXTENSIONS

SPELL_PROSELINT: Matching files extensions

Type: array of string Default: [".md", ".txt"]

SPELL_PROSELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_FILE_EXTENSIONS SPELL_PROSELINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SPELL_PROSELINT_FILE_NAMES_REGEX

SPELL_PROSELINT: Matching file name regexes

Type: array of string Default: []

SPELL_PROSELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_FILE_NAMES_REGEX SPELL_PROSELINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_PROSELINT_FILTER_REGEX_EXCLUDE

SPELL_PROSELINT: Excluding Regex

Type: string

SPELL_PROSELINT: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_PROSELINT_FILTER_REGEX_INCLUDE

SPELL_PROSELINT: Including Regex

Type: string

SPELL_PROSELINT: Custom regex including filter: only files matching this regex will be linted

root SPELL_PROSELINT_POST_COMMANDS

SPELL_PROSELINT: Post-run commands

Type: array

SPELLPROSELINT: Define bash commands to run after running SPELLPROSELINT

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_PROSELINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_PROSELINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_PROSELINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_PROSELINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_PROSELINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_PROSELINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_PROSELINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_PROSELINT_PRE_COMMANDS

SPELL_PROSELINT: Pre-run commands

Type: array

SPELLPROSELINT: Define bash commands to run before running SPELLPROSELINT

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_PROSELINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_PROSELINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_PROSELINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_PROSELINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_PROSELINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_PROSELINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_PROSELINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_PROSELINT_RULES_PATH

SPELL_PROSELINT: Custom config file path

Type: string

SPELL_PROSELINT: Path where to find linter configuration file

root SPELL_PROSELINT_UNSECURED_ENV_VARIABLES

SPELL_PROSELINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SPELL_PROSELINT_UNSECURED_ENV_VARIABLES SPELL_PROSELINT_UNSECURED_ENV_VARIABLES items
Type: string

root SPELL_VALE_ARGUMENTS

SPELL_VALE: Custom arguments

Type: array of string or string

SPELL_VALE: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SPELL_VALE_ARGUMENTS SPELL_VALE_ARGUMENTS items
Type: string

root SPELL_VALE_CLI_EXECUTABLE

SPELL_VALE: CLI Executable

Type: array of string Default: [["vale"]]

SPELL_VALE: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SPELL_VALE_CLI_EXECUTABLE SPELL_VALE_CLI_EXECUTABLE items
Type: string

root SPELL_VALE_CLI_LINT_MODE

SPELL_VALE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_VALE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SPELL_VALE_COMMAND_REMOVE_ARGUMENTS

SPELL_VALE: Custom remove arguments

Type: array of string or string

SPELL_VALE: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SPELL_VALE_COMMAND_REMOVE_ARGUMENTS SPELL_VALE_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SPELL_VALE_CONFIG_FILE

SPELL_VALE: Custom config file name

Type: string Default: ".vale.ini"

SPELL_VALE: User custom config file name if different from default

root SPELL_VALE_DISABLE_ERRORS

SPELL_VALE: Disable errors

Type: boolean Default: false

SPELLVALE: If true, SPELLVALE doesn't make MegaLinter fail even if errors are found

root SPELL_VALE_DISABLE_ERRORS_IF_LESS_THAN

SPELL_VALE: Maximum number of errors allowed

Type: number Default: 0

SPELLVALE: If the number of errors found is less than this value, SPELLVALE doesn't make MegaLinter fail

root SPELL_VALE_FILE_EXTENSIONS

SPELL_VALE: Matching files extensions

Type: array of string Default: [".md", ".rst"]

SPELL_VALE: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_VALE_FILE_EXTENSIONS SPELL_VALE_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SPELL_VALE_FILE_NAMES_REGEX

SPELL_VALE: Matching file name regexes

Type: array of string Default: []

SPELL_VALE: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SPELL_VALE_FILE_NAMES_REGEX SPELL_VALE_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SPELL_VALE_FILTER_REGEX_EXCLUDE

SPELL_VALE: Excluding Regex

Type: string

SPELL_VALE: Custom regex excluding filter: files matching this regex will NOT be linted

root SPELL_VALE_FILTER_REGEX_INCLUDE

SPELL_VALE: Including Regex

Type: string

SPELL_VALE: Custom regex including filter: only files matching this regex will be linted

root SPELL_VALE_POST_COMMANDS

SPELL_VALE: Post-run commands

Type: array

SPELLVALE: Define bash commands to run after running SPELLVALE

 No Additional Items

Each item of this array must be:

root SPELL_VALE_POST_COMMANDS Command

Command

Type: object

Command information

root SPELL_VALE_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_VALE_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_VALE_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_VALE_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_VALE_POST_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_VALE_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_VALE_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_VALE_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_VALE_PRE_COMMANDS

SPELL_VALE: Pre-run commands

Type: array

SPELLVALE: Define bash commands to run before running SPELLVALE

 No Additional Items

Each item of this array must be:

root SPELL_VALE_PRE_COMMANDS Command

Command

Type: object

Command information

root SPELL_VALE_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SPELL_VALE_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SPELL_VALE_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SPELL_VALE_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SPELL_VALE_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SPELL_VALE_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SPELL_VALE_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SPELL_VALE_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SPELL_VALE_RULES_PATH

SPELL_VALE: Custom config file path

Type: string

SPELL_VALE: Path where to find linter configuration file

root SPELL_VALE_UNSECURED_ENV_VARIABLES

SPELL_VALE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_VALE and its pre/post commands

 No Additional Items

Each item of this array must be:

root SPELL_VALE_UNSECURED_ENV_VARIABLES SPELL_VALE_UNSECURED_ENV_VARIABLES items
Type: string

root SQL_FILTER_REGEX_EXCLUDE

Excluding regex filter for SQL descriptor

Type: string

SQL: Custom regex excluding filter: files matching this regex will NOT be linted

root SQL_FILTER_REGEX_INCLUDE

Including regex filter for SQL descriptor

Type: string

SQL: Custom regex including filter: only files matching this regex will be linted

root SQL_POST_COMMANDS

Post commands for SQL descriptor

Type: array

SQL: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SQL_POST_COMMANDS Command

Command

Type: object

Command information

root SQL_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_POST_COMMANDS Command output_variables output_variables items
Type: string

root SQL_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_PRE_COMMANDS

Pre commands for SQL descriptor

Type: array

SQL: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SQL_PRE_COMMANDS Command

Command

Type: object

Command information

root SQL_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SQL_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_SQLFLUFF_ARGUMENTS

SQL_SQLFLUFF: Custom arguments

Type: array of string or string

SQL_SQLFLUFF: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_ARGUMENTS SQL_SQLFLUFF_ARGUMENTS items
Type: string

root SQL_SQLFLUFF_CLI_EXECUTABLE

SQL_SQLFLUFF: CLI Executable

Type: array of string Default: [["sqlfluff"]]

SQL_SQLFLUFF: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_CLI_EXECUTABLE SQL_SQLFLUFF_CLI_EXECUTABLE items
Type: string

root SQL_SQLFLUFF_CLI_LINT_MODE

SQL_SQLFLUFF: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SQL_SQLFLUFF: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS

SQL_SQLFLUFF: Custom remove arguments

Type: array of string or string

SQL_SQLFLUFF: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SQL_SQLFLUFF_CONFIG_FILE

SQL_SQLFLUFF: Custom config file name

Type: string Default: ".sqlfluff"

SQL_SQLFLUFF: User custom config file name if different from default

root SQL_SQLFLUFF_DISABLE_ERRORS

SQL_SQLFLUFF: Disable errors

Type: boolean Default: false

SQLSQLFLUFF: If true, SQLSQLFLUFF doesn't make MegaLinter fail even if errors are found

root SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN

SQL_SQLFLUFF: Maximum number of errors allowed

Type: number Default: 0

SQLSQLFLUFF: If the number of errors found is less than this value, SQLSQLFLUFF doesn't make MegaLinter fail

root SQL_SQLFLUFF_FILE_EXTENSIONS

SQL_SQLFLUFF: Matching files extensions

Type: array of string Default: [".sql"]

SQL_SQLFLUFF: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_FILE_EXTENSIONS SQL_SQLFLUFF_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SQL_SQLFLUFF_FILE_NAMES_REGEX

SQL_SQLFLUFF: Matching file name regexes

Type: array of string Default: []

SQL_SQLFLUFF: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_FILE_NAMES_REGEX SQL_SQLFLUFF_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE

SQL_SQLFLUFF: Excluding Regex

Type: string

SQL_SQLFLUFF: Custom regex excluding filter: files matching this regex will NOT be linted

root SQL_SQLFLUFF_FILTER_REGEX_INCLUDE

SQL_SQLFLUFF: Including Regex

Type: string

SQL_SQLFLUFF: Custom regex including filter: only files matching this regex will be linted

root SQL_SQLFLUFF_POST_COMMANDS

SQL_SQLFLUFF: Post-run commands

Type: array

SQLSQLFLUFF: Define bash commands to run after running SQLSQLFLUFF

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_POST_COMMANDS Command

Command

Type: object

Command information

root SQL_SQLFLUFF_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_SQLFLUFF_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_SQLFLUFF_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_SQLFLUFF_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_POST_COMMANDS Command output_variables output_variables items
Type: string

root SQL_SQLFLUFF_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_SQLFLUFF_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_SQLFLUFF_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_SQLFLUFF_PRE_COMMANDS

SQL_SQLFLUFF: Pre-run commands

Type: array

SQLSQLFLUFF: Define bash commands to run before running SQLSQLFLUFF

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_PRE_COMMANDS Command

Command

Type: object

Command information

root SQL_SQLFLUFF_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_SQLFLUFF_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_SQLFLUFF_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_SQLFLUFF_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SQL_SQLFLUFF_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_SQLFLUFF_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_SQLFLUFF_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_SQLFLUFF_RULES_PATH

SQL_SQLFLUFF: Custom config file path

Type: string

SQL_SQLFLUFF: Path where to find linter configuration file

root SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES

SQL_SQLFLUFF: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQL_SQLFLUFF and its pre/post commands

 No Additional Items

Each item of this array must be:

root SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES items
Type: string

root SQL_SQL_LINT_ARGUMENTS

SQL_SQL_LINT: Custom arguments

Type: array of string or string

SQLSQLLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_ARGUMENTS SQL_SQL_LINT_ARGUMENTS items
Type: string

root SQL_SQL_LINT_CLI_EXECUTABLE

SQL_SQL_LINT: CLI Executable

Type: array of string Default: [["sql-lint"]]
No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_CLI_EXECUTABLE SQL_SQL_LINT_CLI_EXECUTABLE items
Type: string

root SQL_SQL_LINT_CLI_LINT_MODE

SQL_SQL_LINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

root SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS

SQL_SQL_LINT: Custom remove arguments

Type: array of string or string

SQLSQLLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SQL_SQL_LINT_CONFIG_FILE

SQL_SQL_LINT: Custom config file name

Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

root SQL_SQL_LINT_DISABLE_ERRORS

SQL_SQL_LINT: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN

SQL_SQL_LINT: Maximum number of errors allowed

Type: number Default: 0

root SQL_SQL_LINT_FILE_EXTENSIONS

SQL_SQL_LINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_FILE_EXTENSIONS SQL_SQL_LINT_FILE_EXTENSIONS items
Type: string

root SQL_SQL_LINT_FILE_NAME

SQL_SQL_LINT: Custom config file name

Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

root SQL_SQL_LINT_FILE_NAMES_REGEX

SQL_SQL_LINT: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_FILE_NAMES_REGEX SQL_SQL_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SQL_SQL_LINT_FILTER_REGEX_EXCLUDE

SQL_SQL_LINT: Excluding Regex

Type: string

root SQL_SQL_LINT_FILTER_REGEX_INCLUDE

SQL_SQL_LINT: Including Regex

Type: string

root SQL_SQL_LINT_POST_COMMANDS

SQL_SQL_LINT: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root SQL_SQL_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_SQL_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_SQL_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_SQL_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SQL_SQL_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_SQL_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_SQL_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_SQL_LINT_PRE_COMMANDS

SQL_SQL_LINT: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root SQL_SQL_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_SQL_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_SQL_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_SQL_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SQL_SQL_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_SQL_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_SQL_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_SQL_LINT_RULES_PATH

SQL_SQL_LINT: Custom config file path

Type: string

SQLSQLLINT: Path where to find linter configuration file

root SQL_SQL_LINT_UNSECURED_ENV_VARIABLES

SQL_SQL_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQLSQLLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SQL_SQL_LINT_UNSECURED_ENV_VARIABLES SQL_SQL_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root SQL_TSQLLINT_ARGUMENTS

SQL_TSQLLINT: Custom arguments

Type: array of string or string

SQL_TSQLLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_ARGUMENTS SQL_TSQLLINT_ARGUMENTS items
Type: string

root SQL_TSQLLINT_CLI_EXECUTABLE

SQL_TSQLLINT: CLI Executable

Type: array of string Default: [["tsqllint"]]

SQL_TSQLLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_CLI_EXECUTABLE SQL_TSQLLINT_CLI_EXECUTABLE items
Type: string

root SQL_TSQLLINT_CLI_LINT_MODE

SQL_TSQLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SQL_TSQLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS

SQL_TSQLLINT: Custom remove arguments

Type: array of string or string

SQL_TSQLLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SQL_TSQLLINT_CONFIG_FILE

SQL_TSQLLINT: Custom config file name

Type: string Default: ".tsqllintrc"

SQL_TSQLLINT: User custom config file name if different from default

root SQL_TSQLLINT_DISABLE_ERRORS

SQL_TSQLLINT: Disable errors

Type: boolean Default: false

SQLTSQLLINT: If true, SQLTSQLLINT doesn't make MegaLinter fail even if errors are found

root SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN

SQL_TSQLLINT: Maximum number of errors allowed

Type: number Default: 0

SQLTSQLLINT: If the number of errors found is less than this value, SQLTSQLLINT doesn't make MegaLinter fail

root SQL_TSQLLINT_FILE_EXTENSIONS

SQL_TSQLLINT: Matching files extensions

Type: array of string Default: [".sql"]

SQL_TSQLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_FILE_EXTENSIONS SQL_TSQLLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SQL_TSQLLINT_FILE_NAMES_REGEX

SQL_TSQLLINT: Matching file name regexes

Type: array of string Default: []

SQL_TSQLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_FILE_NAMES_REGEX SQL_TSQLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SQL_TSQLLINT_FILTER_REGEX_EXCLUDE

SQL_TSQLLINT: Excluding Regex

Type: string

SQL_TSQLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root SQL_TSQLLINT_FILTER_REGEX_INCLUDE

SQL_TSQLLINT: Including Regex

Type: string

SQL_TSQLLINT: Custom regex including filter: only files matching this regex will be linted

root SQL_TSQLLINT_POST_COMMANDS

SQL_TSQLLINT: Post-run commands

Type: array

SQLTSQLLINT: Define bash commands to run after running SQLTSQLLINT

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_POST_COMMANDS Command

Command

Type: object

Command information

root SQL_TSQLLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_TSQLLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_TSQLLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_TSQLLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SQL_TSQLLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_TSQLLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_TSQLLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_TSQLLINT_PRE_COMMANDS

SQL_TSQLLINT: Pre-run commands

Type: array

SQLTSQLLINT: Define bash commands to run before running SQLTSQLLINT

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root SQL_TSQLLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SQL_TSQLLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SQL_TSQLLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SQL_TSQLLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SQL_TSQLLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SQL_TSQLLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SQL_TSQLLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SQL_TSQLLINT_RULES_PATH

SQL_TSQLLINT: Custom config file path

Type: string

SQL_TSQLLINT: Path where to find linter configuration file

root SQL_TSQLLINT_UNSECURED_ENV_VARIABLES

SQL_TSQLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQL_TSQLLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SQL_TSQLLINT_UNSECURED_ENV_VARIABLES SQL_TSQLLINT_UNSECURED_ENV_VARIABLES items
Type: string

root SWIFT_FILTER_REGEX_EXCLUDE

Excluding regex filter for SWIFT descriptor

Type: string

SWIFT: Custom regex excluding filter: files matching this regex will NOT be linted

root SWIFT_FILTER_REGEX_INCLUDE

Including regex filter for SWIFT descriptor

Type: string

SWIFT: Custom regex including filter: only files matching this regex will be linted

root SWIFT_POST_COMMANDS

Post commands for SWIFT descriptor

Type: array

SWIFT: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root SWIFT_POST_COMMANDS Command

Command

Type: object

Command information

root SWIFT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SWIFT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SWIFT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SWIFT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SWIFT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SWIFT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SWIFT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SWIFT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SWIFT_PRE_COMMANDS

Pre commands for SWIFT descriptor

Type: array

SWIFT: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root SWIFT_PRE_COMMANDS Command

Command

Type: object

Command information

root SWIFT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SWIFT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SWIFT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SWIFT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SWIFT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SWIFT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SWIFT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SWIFT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SWIFT_SWIFTLINT_ARGUMENTS

SWIFT_SWIFTLINT: Custom arguments

Type: array of string or string

SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_ARGUMENTS SWIFT_SWIFTLINT_ARGUMENTS items
Type: string

root SWIFT_SWIFTLINT_CLI_EXECUTABLE

SWIFT_SWIFTLINT: CLI Executable

Type: array of string Default: [["swiftlint"]]

SWIFT_SWIFTLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_CLI_EXECUTABLE SWIFT_SWIFTLINT_CLI_EXECUTABLE items
Type: string

root SWIFT_SWIFTLINT_CLI_LINT_MODE

SWIFT_SWIFTLINT: CLI lint mode

Type: enum (of string) Default: "project"

SWIFT_SWIFTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS

SWIFT_SWIFTLINT: Custom remove arguments

Type: array of string or string

SWIFT_SWIFTLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root SWIFT_SWIFTLINT_CONFIG_FILE

SWIFT_SWIFTLINT: Custom config file name

Type: string Default: ".swiftlint.yml"

SWIFT_SWIFTLINT: User custom config file name if different from default

root SWIFT_SWIFTLINT_DISABLE_ERRORS

SWIFT_SWIFTLINT: Disable errors

Type: boolean Default: false

SWIFTSWIFTLINT: If true, SWIFTSWIFTLINT doesn't make MegaLinter fail even if errors are found

root SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN

SWIFT_SWIFTLINT: Maximum number of errors allowed

Type: number Default: 0

SWIFTSWIFTLINT: If the number of errors found is less than this value, SWIFTSWIFTLINT doesn't make MegaLinter fail

root SWIFT_SWIFTLINT_FILE_EXTENSIONS

SWIFT_SWIFTLINT: Matching files extensions

Type: array of string Default: [".swift"]

SWIFT_SWIFTLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_FILE_EXTENSIONS SWIFT_SWIFTLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root SWIFT_SWIFTLINT_FILE_NAMES_REGEX

SWIFT_SWIFTLINT: Matching file name regexes

Type: array of string Default: []

SWIFT_SWIFTLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_FILE_NAMES_REGEX SWIFT_SWIFTLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root SWIFT_SWIFTLINT_POST_COMMANDS

SWIFT_SWIFTLINT: Post-run commands

Type: array

SWIFTSWIFTLINT: Define bash commands to run after running SWIFTSWIFTLINT

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_POST_COMMANDS Command

Command

Type: object

Command information

root SWIFT_SWIFTLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SWIFT_SWIFTLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SWIFT_SWIFTLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SWIFT_SWIFTLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root SWIFT_SWIFTLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SWIFT_SWIFTLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SWIFT_SWIFTLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SWIFT_SWIFTLINT_PRE_COMMANDS

SWIFT_SWIFTLINT: Pre-run commands

Type: array

SWIFTSWIFTLINT: Define bash commands to run before running SWIFTSWIFTLINT

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root SWIFT_SWIFTLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root SWIFT_SWIFTLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root SWIFT_SWIFTLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root SWIFT_SWIFTLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root SWIFT_SWIFTLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root SWIFT_SWIFTLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root SWIFT_SWIFTLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root SWIFT_SWIFTLINT_RULES_PATH

SWIFT_SWIFTLINT: Custom config file path

Type: string

SWIFT_SWIFTLINT: Path where to find linter configuration file

root SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES

SWIFT_SWIFTLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SWIFT_SWIFTLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES items
Type: string

root TAP_REPORTER

Activate TAP reporter

Type: boolean Default: false

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

root TAP_REPORTER_SUB_FOLDER

TAP reporter sub folder

Type: string Default: "tap"

Sub-folder of reports folder containing TAP logs

root TEKTON_FILTER_REGEX_EXCLUDE

Excluding regex filter for TEKTON descriptor

Type: string

TEKTON: Custom regex excluding filter: files matching this regex will NOT be linted

root TEKTON_FILTER_REGEX_INCLUDE

Including regex filter for TEKTON descriptor

Type: string

TEKTON: Custom regex including filter: only files matching this regex will be linted

root TEKTON_POST_COMMANDS

Post commands for TEKTON descriptor

Type: array

TEKTON: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root TEKTON_POST_COMMANDS Command

Command

Type: object

Command information

root TEKTON_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TEKTON_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TEKTON_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TEKTON_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TEKTON_POST_COMMANDS Command output_variables output_variables items
Type: string

root TEKTON_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TEKTON_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TEKTON_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TEKTON_PRE_COMMANDS

Pre commands for TEKTON descriptor

Type: array

TEKTON: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root TEKTON_PRE_COMMANDS Command

Command

Type: object

Command information

root TEKTON_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TEKTON_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TEKTON_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TEKTON_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TEKTON_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TEKTON_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TEKTON_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TEKTON_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TEKTON_TEKTON_LINT_ARGUMENTS

TEKTON_TEKTON_LINT: Custom arguments

Type: array of string or string

TEKTONTEKTONLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_ARGUMENTS TEKTON_TEKTON_LINT_ARGUMENTS items
Type: string

root TEKTON_TEKTON_LINT_CLI_EXECUTABLE

TEKTON_TEKTON_LINT: CLI Executable

Type: array of string Default: [["tekton-lint"]]

TEKTONTEKTONLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_CLI_EXECUTABLE TEKTON_TEKTON_LINT_CLI_EXECUTABLE items
Type: string

root TEKTON_TEKTON_LINT_CLI_LINT_MODE

TEKTON_TEKTON_LINT: CLI lint mode

Type: enum (of string) Default: "file"

TEKTONTEKTONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS

TEKTON_TEKTON_LINT: Custom remove arguments

Type: array of string or string

TEKTONTEKTONLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TEKTON_TEKTON_LINT_CONFIG_FILE

TEKTON_TEKTON_LINT: Custom config file name

Type: string Default: ".tektonlintrc.yaml"

TEKTONTEKTONLINT: User custom config file name if different from default

root TEKTON_TEKTON_LINT_DISABLE_ERRORS

TEKTON_TEKTON_LINT: Disable errors

Type: boolean Default: false

TEKTONTEKTONLINT: If true, TEKTONTEKTONLINT doesn't make MegaLinter fail even if errors are found

root TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN

TEKTON_TEKTON_LINT: Maximum number of errors allowed

Type: number Default: 0

TEKTONTEKTONLINT: If the number of errors found is less than this value, TEKTONTEKTONLINT doesn't make MegaLinter fail

root TEKTON_TEKTON_LINT_FILE_EXTENSIONS

TEKTON_TEKTON_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

TEKTONTEKTONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_FILE_EXTENSIONS TEKTON_TEKTON_LINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TEKTON_TEKTON_LINT_FILE_NAMES_REGEX

TEKTON_TEKTON_LINT: Matching file name regexes

Type: array of string Default: []

TEKTONTEKTONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_FILE_NAMES_REGEX TEKTON_TEKTON_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE

TEKTON_TEKTON_LINT: Excluding Regex

Type: string

TEKTONTEKTONLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE

TEKTON_TEKTON_LINT: Including Regex

Type: string

TEKTONTEKTONLINT: Custom regex including filter: only files matching this regex will be linted

root TEKTON_TEKTON_LINT_POST_COMMANDS

TEKTON_TEKTON_LINT: Post-run commands

Type: array

TEKTONTEKTONLINT: Define bash commands to run after running TEKTONTEKTONLINT

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_POST_COMMANDS Command

Command

Type: object

Command information

root TEKTON_TEKTON_LINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TEKTON_TEKTON_LINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TEKTON_TEKTON_LINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TEKTON_TEKTON_LINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TEKTON_TEKTON_LINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TEKTON_TEKTON_LINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TEKTON_TEKTON_LINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TEKTON_TEKTON_LINT_PRE_COMMANDS

TEKTON_TEKTON_LINT: Pre-run commands

Type: array

TEKTONTEKTONLINT: Define bash commands to run before running TEKTONTEKTONLINT

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command

Command

Type: object

Command information

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TEKTON_TEKTON_LINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TEKTON_TEKTON_LINT_RULES_PATH

TEKTON_TEKTON_LINT: Custom config file path

Type: string

TEKTONTEKTONLINT: Path where to find linter configuration file

root TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES

TEKTON_TEKTON_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TEKTONTEKTONLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES items
Type: string

root TERRAFORM_CHECKOV_ARGUMENTS

(removed) TERRAFORM_CHECKOV: Custom arguments

Type: array of string or string

TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_ARGUMENTS TERRAFORM_CHECKOV_ARGUMENTS items
Type: string

root TERRAFORM_CHECKOV_CLI_EXECUTABLE

(removed) TERRAFORM_CHECKOV: CLI Executable

Type: array of string Default: [["checkov"]]
No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_CLI_EXECUTABLE TERRAFORM_CHECKOV_CLI_EXECUTABLE items
Type: string

root TERRAFORM_CHECKOV_CLI_LINT_MODE

(removed) TERRAFORM_CHECKOV: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

root TERRAFORM_CHECKOV_DISABLE_ERRORS

(removed) TERRAFORM_CHECKOV: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN

(removed) TERRAFORM_CHECKOV: Maximum number of errors allowed

Type: number Default: 0

root TERRAFORM_CHECKOV_FILE_EXTENSIONS

(removed) TERRAFORM_CHECKOV: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_FILE_EXTENSIONS TERRAFORM_CHECKOV_FILE_EXTENSIONS items
Type: string

root TERRAFORM_CHECKOV_FILE_NAMES_REGEX

(removed) TERRAFORM_CHECKOV: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_FILE_NAMES_REGEX TERRAFORM_CHECKOV_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE

(removed) TERRAFORM_CHECKOV: Excluding Regex

Type: string

root TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE

(removed) TERRAFORM_CHECKOV: Including Regex

Type: string

root TERRAFORM_CHECKOV_POST_COMMANDS

(removed) TERRAFORM_CHECKOV: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_CHECKOV_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_CHECKOV_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_CHECKOV_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_CHECKOV_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_CHECKOV_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_CHECKOV_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_CHECKOV_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_CHECKOV_PRE_COMMANDS

(removed) TERRAFORM_CHECKOV: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_CHECKOV_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_CHECKOV_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_CHECKOV_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_CHECKOV_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_CHECKOV_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_CHECKOV_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_CHECKOV_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_CHECKOV_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_FILTER_REGEX_EXCLUDE

Excluding regex filter for TERRAFORM descriptor

Type: string

TERRAFORM: Custom regex excluding filter: files matching this regex will NOT be linted

root TERRAFORM_FILTER_REGEX_INCLUDE

Including regex filter for TERRAFORM descriptor

Type: string

TERRAFORM: Custom regex including filter: only files matching this regex will be linted

root TERRAFORM_KICS_ARGUMENTS

(removed) TERRAFORM_KICS: Custom arguments

Type: array of string or string

TERRAFORM_KICS: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_ARGUMENTS TERRAFORM_KICS_ARGUMENTS items
Type: string

root TERRAFORM_KICS_CLI_EXECUTABLE

(removed) TERRAFORM_KICS: CLI Executable

Type: array of string Default: [["kics"]]
No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_CLI_EXECUTABLE TERRAFORM_KICS_CLI_EXECUTABLE items
Type: string

root TERRAFORM_KICS_CLI_LINT_MODE

(removed) TERRAFORM_KICS: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

root TERRAFORM_KICS_DISABLE_ERRORS

(removed) TERRAFORM_KICS: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

root TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN

(removed) TERRAFORM_KICS: Maximum number of errors allowed

Type: number Default: 0

root TERRAFORM_KICS_FILE_EXTENSIONS

(removed) TERRAFORM_KICS: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_FILE_EXTENSIONS TERRAFORM_KICS_FILE_EXTENSIONS items
Type: string

root TERRAFORM_KICS_FILE_NAMES_REGEX

(removed) TERRAFORM_KICS: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_FILE_NAMES_REGEX TERRAFORM_KICS_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_KICS_FILTER_REGEX_EXCLUDE

(removed) TERRAFORM_KICS: Excluding Regex

Type: string

root TERRAFORM_KICS_FILTER_REGEX_INCLUDE

(removed) TERRAFORM_KICS: Including Regex

Type: string

root TERRAFORM_KICS_POST_COMMANDS

(removed) TERRAFORM_KICS: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_KICS_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_KICS_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_KICS_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_KICS_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_KICS_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_KICS_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_KICS_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_KICS_PRE_COMMANDS

(removed) TERRAFORM_KICS: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_KICS_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_KICS_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_KICS_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_KICS_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_KICS_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_KICS_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_KICS_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_KICS_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_POST_COMMANDS

Post commands for TERRAFORM descriptor

Type: array

TERRAFORM: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root TERRAFORM_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_PRE_COMMANDS

Pre commands for TERRAFORM descriptor

Type: array

TERRAFORM: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root TERRAFORM_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRAFORM_FMT_ARGUMENTS

TERRAFORM_TERRAFORM_FMT: Custom arguments

Type: array of string or string

TERRAFORMTERRAFORMFMT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_ARGUMENTS TERRAFORM_TERRAFORM_FMT_ARGUMENTS items
Type: string

root TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE

TERRAFORM_TERRAFORM_FMT: CLI Executable

Type: array of string Default: [["terraform"]]

TERRAFORMTERRAFORMFMT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE items
Type: string

root TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE

TERRAFORM_TERRAFORM_FMT: CLI lint mode

Type: enum (of string) Default: "file"

TERRAFORMTERRAFORMFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS

TERRAFORM_TERRAFORM_FMT: Custom remove arguments

Type: array of string or string

TERRAFORMTERRAFORMFMT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS

TERRAFORM_TERRAFORM_FMT: Disable errors

Type: boolean Default: false

TERRAFORMTERRAFORMFMT: If true, TERRAFORMTERRAFORMFMT doesn't make MegaLinter fail even if errors are found

root TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN

TERRAFORM_TERRAFORM_FMT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRAFORMFMT: If the number of errors found is less than this value, TERRAFORMTERRAFORMFMT doesn't make MegaLinter fail

root TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS

TERRAFORM_TERRAFORM_FMT: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORMTERRAFORMFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX

TERRAFORM_TERRAFORM_FMT: Matching file name regexes

Type: array of string Default: []

TERRAFORMTERRAFORMFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE

TERRAFORM_TERRAFORM_FMT: Excluding Regex

Type: string

TERRAFORMTERRAFORMFMT: Custom regex excluding filter: files matching this regex will NOT be linted

root TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE

TERRAFORM_TERRAFORM_FMT: Including Regex

Type: string

TERRAFORMTERRAFORMFMT: Custom regex including filter: only files matching this regex will be linted

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS

TERRAFORM_TERRAFORM_FMT: Post-run commands

Type: array

TERRAFORMTERRAFORMFMT: Define bash commands to run after running TERRAFORMTERRAFORMFMT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS

TERRAFORM_TERRAFORM_FMT: Pre-run commands

Type: array

TERRAFORMTERRAFORMFMT: Define bash commands to run before running TERRAFORMTERRAFORMFMT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES

TERRAFORM_TERRAFORM_FMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORMTERRAFORMFMT and its pre/post commands

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES items
Type: string

root TERRAFORM_TERRAGRUNT_ARGUMENTS

TERRAFORM_TERRAGRUNT: Custom arguments

Type: array of string or string

TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_ARGUMENTS TERRAFORM_TERRAGRUNT_ARGUMENTS items
Type: string

root TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE

TERRAFORM_TERRAGRUNT: CLI Executable

Type: array of string Default: [["terragrunt"]]

TERRAFORM_TERRAGRUNT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE items
Type: string

root TERRAFORM_TERRAGRUNT_CLI_LINT_MODE

TERRAFORM_TERRAGRUNT: CLI lint mode

Type: enum (of string) Default: "file"

TERRAFORM_TERRAGRUNT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

root TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS

TERRAFORM_TERRAGRUNT: Custom remove arguments

Type: array of string or string

TERRAFORM_TERRAGRUNT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TERRAFORM_TERRAGRUNT_CONFIG_FILE

TERRAFORM_TERRAGRUNT: Custom config file name

Type: string Default: "terragrunt.hcl"

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

root TERRAFORM_TERRAGRUNT_DISABLE_ERRORS

TERRAFORM_TERRAGRUNT: Disable errors

Type: boolean Default: false

TERRAFORMTERRAGRUNT: If true, TERRAFORMTERRAGRUNT doesn't make MegaLinter fail even if errors are found

root TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN

TERRAFORM_TERRAGRUNT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRAGRUNT: If the number of errors found is less than this value, TERRAFORMTERRAGRUNT doesn't make MegaLinter fail

root TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS

TERRAFORM_TERRAGRUNT: Matching files extensions

Type: array of string Default: [".hcl"]

TERRAFORM_TERRAGRUNT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX

TERRAFORM_TERRAGRUNT: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TERRAGRUNT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE

TERRAFORM_TERRAGRUNT: Excluding Regex

Type: string

TERRAFORM_TERRAGRUNT: Custom regex excluding filter: files matching this regex will NOT be linted

root TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE

TERRAFORM_TERRAGRUNT: Including Regex

Type: string

TERRAFORM_TERRAGRUNT: Custom regex including filter: only files matching this regex will be linted

root TERRAFORM_TERRAGRUNT_POST_COMMANDS

TERRAFORM_TERRAGRUNT: Post-run commands

Type: array

TERRAFORMTERRAGRUNT: Define bash commands to run after running TERRAFORMTERRAGRUNT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRAGRUNT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS

TERRAFORM_TERRAGRUNT: Pre-run commands

Type: array

TERRAFORMTERRAGRUNT: Define bash commands to run before running TERRAFORMTERRAGRUNT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRAGRUNT_RULES_PATH

TERRAFORM_TERRAGRUNT: Custom config file path

Type: string

TERRAFORM_TERRAGRUNT: Path where to find linter configuration file

root TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES

TERRAFORM_TERRAGRUNT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TERRAGRUNT and its pre/post commands

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES items
Type: string

root TERRAFORM_TERRASCAN_ARGUMENTS

(deprecated) TERRAFORM_TERRASCAN: Custom arguments

Type: array of string or string

TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_ARGUMENTS TERRAFORM_TERRASCAN_ARGUMENTS items
Type: string

root TERRAFORM_TERRASCAN_CLI_EXECUTABLE

(deprecated) TERRAFORM_TERRASCAN: CLI Executable

Type: array of string Default: [["terrascan"]]

TERRAFORM_TERRASCAN: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_CLI_EXECUTABLE TERRAFORM_TERRASCAN_CLI_EXECUTABLE items
Type: string

root TERRAFORM_TERRASCAN_CLI_LINT_MODE

(deprecated) TERRAFORM_TERRASCAN: CLI lint mode

Type: enum (of string) Default: "project"

TERRAFORM_TERRASCAN: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS

(deprecated) TERRAFORM_TERRASCAN: Custom remove arguments

Type: array of string or string

TERRAFORM_TERRASCAN: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TERRAFORM_TERRASCAN_CONFIG_FILE

(deprecated) TERRAFORM_TERRASCAN: Custom config file name

Type: string Default: "terrascan.toml"

TERRAFORM_TERRASCAN: User custom config file name if different from default

root TERRAFORM_TERRASCAN_DISABLE_ERRORS

(deprecated) TERRAFORM_TERRASCAN: Disable errors

Type: boolean Default: false

TERRAFORMTERRASCAN: If true, TERRAFORMTERRASCAN doesn't make MegaLinter fail even if errors are found

root TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN

(deprecated) TERRAFORM_TERRASCAN: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRASCAN: If the number of errors found is less than this value, TERRAFORMTERRASCAN doesn't make MegaLinter fail

root TERRAFORM_TERRASCAN_FILE_EXTENSIONS

(deprecated) TERRAFORM_TERRASCAN: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORM_TERRASCAN: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_FILE_EXTENSIONS TERRAFORM_TERRASCAN_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TERRAFORM_TERRASCAN_FILE_NAMES_REGEX

(deprecated) TERRAFORM_TERRASCAN: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TERRASCAN: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_FILE_NAMES_REGEX TERRAFORM_TERRASCAN_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_TERRASCAN_POST_COMMANDS

TERRAFORM_TERRASCAN: Post-run commands

Type: array

(deprecated) TERRAFORMTERRASCAN: Define bash commands to run after running TERRAFORMTERRASCAN

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRASCAN_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRASCAN_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRASCAN_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRASCAN_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRASCAN_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRASCAN_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRASCAN_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRASCAN_PRE_COMMANDS

TERRAFORM_TERRASCAN: Pre-run commands

Type: array

(deprecated) TERRAFORMTERRASCAN: Define bash commands to run before running TERRAFORMTERRASCAN

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TERRASCAN_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TERRASCAN_RULES_PATH

(deprecated) TERRAFORM_TERRASCAN: Custom config file path

Type: string

TERRAFORM_TERRASCAN: Path where to find linter configuration file

root TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES

(deprecated) TERRAFORM_TERRASCAN: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TERRASCAN and its pre/post commands

 No Additional Items

Each item of this array must be:

root TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES items
Type: string

root TERRAFORM_TFLINT_ARGUMENTS

TERRAFORM_TFLINT: Custom arguments

Type: array of string or string

TERRAFORM_TFLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_ARGUMENTS TERRAFORM_TFLINT_ARGUMENTS items
Type: string

root TERRAFORM_TFLINT_CLI_EXECUTABLE

TERRAFORM_TFLINT: CLI Executable

Type: array of string Default: [["tflint"]]

TERRAFORM_TFLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_CLI_EXECUTABLE TERRAFORM_TFLINT_CLI_EXECUTABLE items
Type: string

root TERRAFORM_TFLINT_CLI_LINT_MODE

TERRAFORM_TFLINT: CLI lint mode

Type: enum (of string) Default: "project"

TERRAFORM_TFLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS

TERRAFORM_TFLINT: Custom remove arguments

Type: array of string or string

TERRAFORM_TFLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TERRAFORM_TFLINT_CONFIG_FILE

TERRAFORM_TFLINT: Custom config file name

Type: string Default: ".tflint.hcl"

TERRAFORM_TFLINT: User custom config file name if different from default

root TERRAFORM_TFLINT_DISABLE_ERRORS

TERRAFORM_TFLINT: Disable errors

Type: boolean Default: false

TERRAFORMTFLINT: If true, TERRAFORMTFLINT doesn't make MegaLinter fail even if errors are found

root TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN

TERRAFORM_TFLINT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTFLINT: If the number of errors found is less than this value, TERRAFORMTFLINT doesn't make MegaLinter fail

root TERRAFORM_TFLINT_FILE_EXTENSIONS

TERRAFORM_TFLINT: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORM_TFLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_FILE_EXTENSIONS TERRAFORM_TFLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TERRAFORM_TFLINT_FILE_NAMES_REGEX

TERRAFORM_TFLINT: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TFLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_FILE_NAMES_REGEX TERRAFORM_TFLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TERRAFORM_TFLINT_POST_COMMANDS

TERRAFORM_TFLINT: Post-run commands

Type: array

TERRAFORMTFLINT: Define bash commands to run after running TERRAFORMTFLINT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_POST_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TFLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TFLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TFLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TFLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TFLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TFLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TFLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TFLINT_PRE_COMMANDS

TERRAFORM_TFLINT: Pre-run commands

Type: array

TERRAFORMTFLINT: Define bash commands to run before running TERRAFORMTFLINT

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root TERRAFORM_TFLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TERRAFORM_TFLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TERRAFORM_TFLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TERRAFORM_TFLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TERRAFORM_TFLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TERRAFORM_TFLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TERRAFORM_TFLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TERRAFORM_TFLINT_RULES_PATH

TERRAFORM_TFLINT: Custom config file path

Type: string

TERRAFORM_TFLINT: Path where to find linter configuration file

root TERRAFORM_TFLINT_SECURED_ENV

TERRAFORM_TFLINT: Secured Environment Flag

Type: boolean Default: true

TERRAFORM_TFLINT: Allows to send the full env to tflint --init. Initialized with default value true. Set to false to allow tflint --init to access your env vars.

root TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES

TERRAFORM_TFLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TFLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES items
Type: string

root TEXT_REPORTER

Activate text reporter

Type: boolean Default: true

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

root TEXT_REPORTER_SUB_FOLDER

Text reporter sub folder

Type: string Default: "linters_logs"

Sub-folder of reports folder containing text logs

root TSX_ESLINT_ARGUMENTS

TSX_ESLINT: Custom arguments

Type: array of string or string

TSX_ESLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_ARGUMENTS TSX_ESLINT_ARGUMENTS items
Type: string

root TSX_ESLINT_CLI_EXECUTABLE

TSX_ESLINT: CLI Executable

Type: array of string Default: [["eslint"]]

TSX_ESLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_CLI_EXECUTABLE TSX_ESLINT_CLI_EXECUTABLE items
Type: string

root TSX_ESLINT_CLI_LINT_MODE

TSX_ESLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TSX_ESLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS

TSX_ESLINT: Custom remove arguments

Type: array of string or string

TSX_ESLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TSX_ESLINT_CONFIG_FILE

TSX_ESLINT: Custom config file name

Type: string Default: ".eslintrc.json"

TSX_ESLINT: User custom config file name if different from default

root TSX_ESLINT_DISABLE_ERRORS

TSX_ESLINT: Disable errors

Type: boolean Default: false

TSXESLINT: If true, TSXESLINT doesn't make MegaLinter fail even if errors are found

root TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN

TSX_ESLINT: Maximum number of errors allowed

Type: number Default: 0

TSXESLINT: If the number of errors found is less than this value, TSXESLINT doesn't make MegaLinter fail

root TSX_ESLINT_FILE_EXTENSIONS

TSX_ESLINT: Matching files extensions

Type: array of string Default: [".tsx"]

TSX_ESLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_FILE_EXTENSIONS TSX_ESLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TSX_ESLINT_FILE_NAMES_REGEX

TSX_ESLINT: Matching file name regexes

Type: array of string Default: []

TSX_ESLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_FILE_NAMES_REGEX TSX_ESLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TSX_ESLINT_FILTER_REGEX_EXCLUDE

TSX_ESLINT: Excluding Regex

Type: string

TSX_ESLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root TSX_ESLINT_FILTER_REGEX_INCLUDE

TSX_ESLINT: Including Regex

Type: string

TSX_ESLINT: Custom regex including filter: only files matching this regex will be linted

root TSX_ESLINT_POST_COMMANDS

TSX_ESLINT: Post-run commands

Type: array

TSXESLINT: Define bash commands to run after running TSXESLINT

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_POST_COMMANDS Command

Command

Type: object

Command information

root TSX_ESLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TSX_ESLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TSX_ESLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TSX_ESLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TSX_ESLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TSX_ESLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TSX_ESLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TSX_ESLINT_PRE_COMMANDS

TSX_ESLINT: Pre-run commands

Type: array

TSXESLINT: Define bash commands to run before running TSXESLINT

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root TSX_ESLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TSX_ESLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TSX_ESLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TSX_ESLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TSX_ESLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TSX_ESLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TSX_ESLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TSX_ESLINT_RULES_PATH

TSX_ESLINT: Custom config file path

Type: string

TSX_ESLINT: Path where to find linter configuration file

root TSX_ESLINT_UNSECURED_ENV_VARIABLES

TSX_ESLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root TSX_ESLINT_UNSECURED_ENV_VARIABLES TSX_ESLINT_UNSECURED_ENV_VARIABLES items
Type: string

root TSX_FILTER_REGEX_EXCLUDE

Excluding regex filter for TSX descriptor

Type: string

TSX: Custom regex excluding filter: files matching this regex will NOT be linted

root TSX_FILTER_REGEX_INCLUDE

Including regex filter for TSX descriptor

Type: string

TSX: Custom regex including filter: only files matching this regex will be linted

root TSX_POST_COMMANDS

Post commands for TSX descriptor

Type: array

TSX: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root TSX_POST_COMMANDS Command

Command

Type: object

Command information

root TSX_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TSX_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TSX_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TSX_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TSX_POST_COMMANDS Command output_variables output_variables items
Type: string

root TSX_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TSX_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TSX_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TSX_PRE_COMMANDS

Pre commands for TSX descriptor

Type: array

TSX: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root TSX_PRE_COMMANDS Command

Command

Type: object

Command information

root TSX_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TSX_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TSX_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TSX_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TSX_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TSX_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TSX_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TSX_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_DEFAULT_STYLE

Typescript default style

Type: enum (of string) Default: "prettier"

Style of typescript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"

"prettier"

root TYPESCRIPT_ES_ARGUMENTS

TYPESCRIPT_ES: Custom arguments

Type: array of string or string

TYPESCRIPT_ES: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_ARGUMENTS TYPESCRIPT_ES_ARGUMENTS items
Type: string

root TYPESCRIPT_ES_CLI_EXECUTABLE

TYPESCRIPT_ES: CLI Executable

Type: array of string Default: [["eslint"]]

TYPESCRIPT_ES: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_CLI_EXECUTABLE TYPESCRIPT_ES_CLI_EXECUTABLE items
Type: string

root TYPESCRIPT_ES_CLI_LINT_MODE

TYPESCRIPT_ES: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_ES: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS

TYPESCRIPT_ES: Custom remove arguments

Type: array of string or string

TYPESCRIPT_ES: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TYPESCRIPT_ES_CONFIG_FILE

TYPESCRIPT_ES: Custom config file name

Type: string Default: ".eslintrc.json"

TYPESCRIPT_ES: User custom config file name if different from default

root TYPESCRIPT_ES_DISABLE_ERRORS

TYPESCRIPT_ES: Disable errors

Type: boolean Default: false

TYPESCRIPTES: If true, TYPESCRIPTES doesn't make MegaLinter fail even if errors are found

root TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN

TYPESCRIPT_ES: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTES: If the number of errors found is less than this value, TYPESCRIPTES doesn't make MegaLinter fail

root TYPESCRIPT_ES_FILE_EXTENSIONS

TYPESCRIPT_ES: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_ES: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_FILE_EXTENSIONS TYPESCRIPT_ES_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TYPESCRIPT_ES_FILE_NAMES_REGEX

TYPESCRIPT_ES: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_ES: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_FILE_NAMES_REGEX TYPESCRIPT_ES_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE

TYPESCRIPT_ES: Excluding Regex

Type: string

TYPESCRIPT_ES: Custom regex excluding filter: files matching this regex will NOT be linted

root TYPESCRIPT_ES_FILTER_REGEX_INCLUDE

TYPESCRIPT_ES: Including Regex

Type: string

TYPESCRIPT_ES: Custom regex including filter: only files matching this regex will be linted

root TYPESCRIPT_ES_POST_COMMANDS

TYPESCRIPT_ES: Post-run commands

Type: array

TYPESCRIPTES: Define bash commands to run after running TYPESCRIPTES

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_POST_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_ES_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_ES_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_ES_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_ES_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_POST_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_ES_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_ES_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_ES_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_ES_PRE_COMMANDS

TYPESCRIPT_ES: Pre-run commands

Type: array

TYPESCRIPTES: Define bash commands to run before running TYPESCRIPTES

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_PRE_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_ES_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_ES_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_ES_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_ES_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_ES_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_ES_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_ES_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_ES_RULES_PATH

TYPESCRIPT_ES: Custom config file path

Type: string

TYPESCRIPT_ES: Path where to find linter configuration file

root TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES

TYPESCRIPT_ES: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES items
Type: string

root TYPESCRIPT_FILTER_REGEX_EXCLUDE

Excluding regex filter for TYPESCRIPT descriptor

Type: string

TYPESCRIPT: Custom regex excluding filter: files matching this regex will NOT be linted

root TYPESCRIPT_FILTER_REGEX_INCLUDE

Including regex filter for TYPESCRIPT descriptor

Type: string

TYPESCRIPT: Custom regex including filter: only files matching this regex will be linted

root TYPESCRIPT_POST_COMMANDS

Post commands for TYPESCRIPT descriptor

Type: array

TYPESCRIPT: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_POST_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_POST_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_PRETTIER_ARGUMENTS

TYPESCRIPT_PRETTIER: Custom arguments

Type: array of string or string

TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_ARGUMENTS TYPESCRIPT_PRETTIER_ARGUMENTS items
Type: string

root TYPESCRIPT_PRETTIER_CLI_EXECUTABLE

TYPESCRIPT_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

TYPESCRIPT_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_CLI_EXECUTABLE TYPESCRIPT_PRETTIER_CLI_EXECUTABLE items
Type: string

root TYPESCRIPT_PRETTIER_CLI_LINT_MODE

TYPESCRIPT_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS

TYPESCRIPT_PRETTIER: Custom remove arguments

Type: array of string or string

TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TYPESCRIPT_PRETTIER_CONFIG_FILE

TYPESCRIPT_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

TYPESCRIPT_PRETTIER: User custom config file name if different from default

root TYPESCRIPT_PRETTIER_DISABLE_ERRORS

TYPESCRIPT_PRETTIER: Disable errors

Type: boolean Default: false

TYPESCRIPTPRETTIER: If true, TYPESCRIPTPRETTIER doesn't make MegaLinter fail even if errors are found

root TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN

TYPESCRIPT_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTPRETTIER: If the number of errors found is less than this value, TYPESCRIPTPRETTIER doesn't make MegaLinter fail

root TYPESCRIPT_PRETTIER_FILE_EXTENSIONS

TYPESCRIPT_PRETTIER: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_FILE_EXTENSIONS TYPESCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX

TYPESCRIPT_PRETTIER: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE

TYPESCRIPT_PRETTIER: Excluding Regex

Type: string

TYPESCRIPT_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

root TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE

TYPESCRIPT_PRETTIER: Including Regex

Type: string

TYPESCRIPT_PRETTIER: Custom regex including filter: only files matching this regex will be linted

root TYPESCRIPT_PRETTIER_POST_COMMANDS

TYPESCRIPT_PRETTIER: Post-run commands

Type: array

TYPESCRIPTPRETTIER: Define bash commands to run after running TYPESCRIPTPRETTIER

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_PRETTIER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_PRETTIER_PRE_COMMANDS

TYPESCRIPT_PRETTIER: Pre-run commands

Type: array

TYPESCRIPTPRETTIER: Define bash commands to run before running TYPESCRIPTPRETTIER

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_PRETTIER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_PRETTIER_RULES_PATH

TYPESCRIPT_PRETTIER: Custom config file path

Type: string

TYPESCRIPT_PRETTIER: Path where to find linter configuration file

root TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES

TYPESCRIPT_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES items
Type: string

root TYPESCRIPT_PRE_COMMANDS

Pre commands for TYPESCRIPT descriptor

Type: array

TYPESCRIPT: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRE_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_STANDARD_ARGUMENTS

TYPESCRIPT_STANDARD: Custom arguments

Type: array of string or string

TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_ARGUMENTS TYPESCRIPT_STANDARD_ARGUMENTS items
Type: string

root TYPESCRIPT_STANDARD_CLI_EXECUTABLE

TYPESCRIPT_STANDARD: CLI Executable

Type: array of string Default: [["ts-standard"]]

TYPESCRIPT_STANDARD: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_CLI_EXECUTABLE TYPESCRIPT_STANDARD_CLI_EXECUTABLE items
Type: string

root TYPESCRIPT_STANDARD_CLI_LINT_MODE

TYPESCRIPT_STANDARD: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_STANDARD: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS

TYPESCRIPT_STANDARD: Custom remove arguments

Type: array of string or string

TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS items
Type: string

root TYPESCRIPT_STANDARD_DISABLE_ERRORS

TYPESCRIPT_STANDARD: Disable errors

Type: boolean Default: false

TYPESCRIPTSTANDARD: If true, TYPESCRIPTSTANDARD doesn't make MegaLinter fail even if errors are found

root TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN

TYPESCRIPT_STANDARD: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTSTANDARD: If the number of errors found is less than this value, TYPESCRIPTSTANDARD doesn't make MegaLinter fail

root TYPESCRIPT_STANDARD_FILE_EXTENSIONS

TYPESCRIPT_STANDARD: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_STANDARD: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_FILE_EXTENSIONS TYPESCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root TYPESCRIPT_STANDARD_FILE_NAMES_REGEX

TYPESCRIPT_STANDARD: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_STANDARD: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_FILE_NAMES_REGEX TYPESCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE

TYPESCRIPT_STANDARD: Excluding Regex

Type: string

TYPESCRIPT_STANDARD: Custom regex excluding filter: files matching this regex will NOT be linted

root TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE

TYPESCRIPT_STANDARD: Including Regex

Type: string

TYPESCRIPT_STANDARD: Custom regex including filter: only files matching this regex will be linted

root TYPESCRIPT_STANDARD_POST_COMMANDS

TYPESCRIPT_STANDARD: Post-run commands

Type: array

TYPESCRIPTSTANDARD: Define bash commands to run after running TYPESCRIPTSTANDARD

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_POST_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_STANDARD_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_STANDARD_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_STANDARD_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_STANDARD_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_POST_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_STANDARD_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_STANDARD_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_STANDARD_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_STANDARD_PRE_COMMANDS

TYPESCRIPT_STANDARD: Pre-run commands

Type: array

TYPESCRIPTSTANDARD: Define bash commands to run before running TYPESCRIPTSTANDARD

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command

Command

Type: object

Command information

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command output_variables output_variables items
Type: string

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root TYPESCRIPT_STANDARD_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES

TYPESCRIPT_STANDARD: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands

 No Additional Items

Each item of this array must be:

root TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES items
Type: string

root UPDATED_SOURCES_REPORTER

Activates/Deactivates updated sources reporter

Type: boolean

root UPDATED_SOURCES_REPORTER_DIR

Sub-folder of reports folder containing updated sources

Type: string

root VALIDATE_ALL_CODEBASE

Validate all code base

Type: boolean Default: true

Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.

root VBDOTNET_DOTNET_FORMAT_ARGUMENTS

VBDOTNET_DOTNET_FORMAT: Custom arguments

Type: array of string or string

VBDOTNETDOTNETFORMAT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_ARGUMENTS VBDOTNET_DOTNET_FORMAT_ARGUMENTS items
Type: string

root VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE

VBDOTNET_DOTNET_FORMAT: CLI Executable

Type: array of string Default: [["dotnet"]]

VBDOTNETDOTNETFORMAT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE items
Type: string

root VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE

VBDOTNET_DOTNET_FORMAT: CLI lint mode

Type: enum (of string) Default: "project"

VBDOTNETDOTNETFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS

VBDOTNET_DOTNET_FORMAT: Custom remove arguments

Type: array of string or string

VBDOTNETDOTNETFORMAT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS

VBDOTNET_DOTNET_FORMAT: Disable errors

Type: boolean Default: false

VBDOTNETDOTNETFORMAT: If true, VBDOTNETDOTNETFORMAT doesn't make MegaLinter fail even if errors are found

root VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN

VBDOTNET_DOTNET_FORMAT: Maximum number of errors allowed

Type: number Default: 0

VBDOTNETDOTNETFORMAT: If the number of errors found is less than this value, VBDOTNETDOTNETFORMAT doesn't make MegaLinter fail

root VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS

VBDOTNET_DOTNET_FORMAT: Matching files extensions

Type: array of string Default: [".vb"]

VBDOTNETDOTNETFORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX

VBDOTNET_DOTNET_FORMAT: Matching file name regexes

Type: array of string Default: []

VBDOTNETDOTNETFORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS

VBDOTNET_DOTNET_FORMAT: Post-run commands

Type: array

VBDOTNETDOTNETFORMAT: Define bash commands to run after running VBDOTNETDOTNETFORMAT

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command

Command

Type: object

Command information

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command output_variables output_variables items
Type: string

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS

VBDOTNET_DOTNET_FORMAT: Pre-run commands

Type: array

VBDOTNETDOTNETFORMAT: Define bash commands to run before running VBDOTNETDOTNETFORMAT

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command

Command

Type: object

Command information

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES

VBDOTNET_DOTNET_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling VBDOTNETDOTNETFORMAT and its pre/post commands

 No Additional Items

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES items
Type: string

root VBDOTNET_FILTER_REGEX_EXCLUDE

Excluding regex filter for VBDOTNET descriptor

Type: string

VBDOTNET: Custom regex excluding filter: files matching this regex will NOT be linted

root VBDOTNET_FILTER_REGEX_INCLUDE

Including regex filter for VBDOTNET descriptor

Type: string

VBDOTNET: Custom regex including filter: only files matching this regex will be linted

root VBDOTNET_POST_COMMANDS

Post commands for VBDOTNET descriptor

Type: array

VBDOTNET: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root VBDOTNET_POST_COMMANDS Command

Command

Type: object

Command information

root VBDOTNET_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root VBDOTNET_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root VBDOTNET_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root VBDOTNET_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root VBDOTNET_POST_COMMANDS Command output_variables output_variables items
Type: string

root VBDOTNET_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root VBDOTNET_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root VBDOTNET_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root VBDOTNET_PRE_COMMANDS

Pre commands for VBDOTNET descriptor

Type: array

VBDOTNET: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root VBDOTNET_PRE_COMMANDS Command

Command

Type: object

Command information

root VBDOTNET_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root VBDOTNET_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root VBDOTNET_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root VBDOTNET_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root VBDOTNET_PRE_COMMANDS Command output_variables output_variables items
Type: string

root VBDOTNET_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root VBDOTNET_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root VBDOTNET_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root XML_FILTER_REGEX_EXCLUDE

Excluding regex filter for XML descriptor

Type: string

XML: Custom regex excluding filter: files matching this regex will NOT be linted

root XML_FILTER_REGEX_INCLUDE

Including regex filter for XML descriptor

Type: string

XML: Custom regex including filter: only files matching this regex will be linted

root XML_POST_COMMANDS

Post commands for XML descriptor

Type: array

XML: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root XML_POST_COMMANDS Command

Command

Type: object

Command information

root XML_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root XML_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root XML_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root XML_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root XML_POST_COMMANDS Command output_variables output_variables items
Type: string

root XML_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root XML_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root XML_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root XML_PRE_COMMANDS

Pre commands for XML descriptor

Type: array

XML: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root XML_PRE_COMMANDS Command

Command

Type: object

Command information

root XML_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root XML_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root XML_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root XML_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root XML_PRE_COMMANDS Command output_variables output_variables items
Type: string

root XML_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root XML_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root XML_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root XML_XMLLINT_ARGUMENTS

XML_XMLLINT: Custom arguments

Type: array of string or string

XML_XMLLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_ARGUMENTS XML_XMLLINT_ARGUMENTS items
Type: string

root XML_XMLLINT_AUTOFORMAT

XML_XMLLINT: If set to `true`, it will reformat and reindent the output

Type: boolean Default: false

root XML_XMLLINT_CLI_EXECUTABLE

XML_XMLLINT: CLI Executable

Type: array of string Default: [["xmllint"]]

XML_XMLLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_CLI_EXECUTABLE XML_XMLLINT_CLI_EXECUTABLE items
Type: string

root XML_XMLLINT_CLI_LINT_MODE

XML_XMLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

XML_XMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS

XML_XMLLINT: Custom remove arguments

Type: array of string or string

XML_XMLLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root XML_XMLLINT_DISABLE_ERRORS

XML_XMLLINT: Disable errors

Type: boolean Default: false

XMLXMLLINT: If true, XMLXMLLINT doesn't make MegaLinter fail even if errors are found

root XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN

XML_XMLLINT: Maximum number of errors allowed

Type: number Default: 0

XMLXMLLINT: If the number of errors found is less than this value, XMLXMLLINT doesn't make MegaLinter fail

root XML_XMLLINT_FILE_EXTENSIONS

XML_XMLLINT: Matching files extensions

Type: array of string Default: [".xml", ".xsd"]

XML_XMLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_FILE_EXTENSIONS XML_XMLLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root XML_XMLLINT_FILE_NAMES_REGEX

XML_XMLLINT: Matching file name regexes

Type: array of string Default: []

XML_XMLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_FILE_NAMES_REGEX XML_XMLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root XML_XMLLINT_FILTER_REGEX_EXCLUDE

XML_XMLLINT: Excluding Regex

Type: string

XML_XMLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root XML_XMLLINT_FILTER_REGEX_INCLUDE

XML_XMLLINT: Including Regex

Type: string

XML_XMLLINT: Custom regex including filter: only files matching this regex will be linted

root XML_XMLLINT_INDENT

XML_XMLLINT: The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true`

Type: string Default: " "

root XML_XMLLINT_POST_COMMANDS

XML_XMLLINT: Post-run commands

Type: array

XMLXMLLINT: Define bash commands to run after running XMLXMLLINT

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_POST_COMMANDS Command

Command

Type: object

Command information

root XML_XMLLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root XML_XMLLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root XML_XMLLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root XML_XMLLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root XML_XMLLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root XML_XMLLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root XML_XMLLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root XML_XMLLINT_PRE_COMMANDS

XML_XMLLINT: Pre-run commands

Type: array

XMLXMLLINT: Define bash commands to run before running XMLXMLLINT

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root XML_XMLLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root XML_XMLLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root XML_XMLLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root XML_XMLLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root XML_XMLLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root XML_XMLLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root XML_XMLLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root XML_XMLLINT_UNSECURED_ENV_VARIABLES

XML_XMLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root XML_XMLLINT_UNSECURED_ENV_VARIABLES XML_XMLLINT_UNSECURED_ENV_VARIABLES items
Type: string

root YAML_FILTER_REGEX_EXCLUDE

Excluding regex filter for YAML descriptor

Type: string

YAML: Custom regex excluding filter: files matching this regex will NOT be linted

root YAML_FILTER_REGEX_INCLUDE

Including regex filter for YAML descriptor

Type: string

YAML: Custom regex including filter: only files matching this regex will be linted

root YAML_POST_COMMANDS

Post commands for YAML descriptor

Type: array

YAML: List of bash commands to run after the linters

 No Additional Items

Each item of this array must be:

root YAML_POST_COMMANDS Command

Command

Type: object

Command information

root YAML_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_POST_COMMANDS Command output_variables output_variables items
Type: string

root YAML_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_PRETTIER_ARGUMENTS

YAML_PRETTIER: Custom arguments

Type: array of string or string

YAML_PRETTIER: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_ARGUMENTS YAML_PRETTIER_ARGUMENTS items
Type: string

root YAML_PRETTIER_CLI_EXECUTABLE

YAML_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

YAML_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_CLI_EXECUTABLE YAML_PRETTIER_CLI_EXECUTABLE items
Type: string

root YAML_PRETTIER_CLI_LINT_MODE

YAML_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS

YAML_PRETTIER: Custom remove arguments

Type: array of string or string

YAML_PRETTIER: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS items
Type: string

root YAML_PRETTIER_CONFIG_FILE

YAML_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

YAML_PRETTIER: User custom config file name if different from default

root YAML_PRETTIER_DISABLE_ERRORS

YAML_PRETTIER: Disable errors

Type: boolean Default: false

YAMLPRETTIER: If true, YAMLPRETTIER doesn't make MegaLinter fail even if errors are found

root YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN

YAML_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

YAMLPRETTIER: If the number of errors found is less than this value, YAMLPRETTIER doesn't make MegaLinter fail

root YAML_PRETTIER_FILE_EXTENSIONS

YAML_PRETTIER: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_FILE_EXTENSIONS YAML_PRETTIER_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root YAML_PRETTIER_FILE_NAMES_REGEX

YAML_PRETTIER: Matching file name regexes

Type: array of string Default: []

YAML_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_FILE_NAMES_REGEX YAML_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root YAML_PRETTIER_FILTER_REGEX_EXCLUDE

YAML_PRETTIER: Excluding Regex

Type: string

YAML_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

root YAML_PRETTIER_FILTER_REGEX_INCLUDE

YAML_PRETTIER: Including Regex

Type: string

YAML_PRETTIER: Custom regex including filter: only files matching this regex will be linted

root YAML_PRETTIER_POST_COMMANDS

YAML_PRETTIER: Post-run commands

Type: array

YAMLPRETTIER: Define bash commands to run after running YAMLPRETTIER

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_POST_COMMANDS Command

Command

Type: object

Command information

root YAML_PRETTIER_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_PRETTIER_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_PRETTIER_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_PRETTIER_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_POST_COMMANDS Command output_variables output_variables items
Type: string

root YAML_PRETTIER_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_PRETTIER_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_PRETTIER_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_PRETTIER_PRE_COMMANDS

YAML_PRETTIER: Pre-run commands

Type: array

YAMLPRETTIER: Define bash commands to run before running YAMLPRETTIER

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_PRE_COMMANDS Command

Command

Type: object

Command information

root YAML_PRETTIER_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_PRETTIER_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_PRETTIER_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_PRETTIER_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_PRE_COMMANDS Command output_variables output_variables items
Type: string

root YAML_PRETTIER_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_PRETTIER_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_PRETTIER_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_PRETTIER_RULES_PATH

YAML_PRETTIER: Custom config file path

Type: string

YAML_PRETTIER: Path where to find linter configuration file

root YAML_PRETTIER_UNSECURED_ENV_VARIABLES

YAML_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands

 No Additional Items

Each item of this array must be:

root YAML_PRETTIER_UNSECURED_ENV_VARIABLES YAML_PRETTIER_UNSECURED_ENV_VARIABLES items
Type: string

root YAML_PRE_COMMANDS

Pre commands for YAML descriptor

Type: array

YAML: List of bash commands to run before the linters

 No Additional Items

Each item of this array must be:

root YAML_PRE_COMMANDS Command

Command

Type: object

Command information

root YAML_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_PRE_COMMANDS Command output_variables output_variables items
Type: string

root YAML_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "composer install",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_V8R_ARGUMENTS

YAML_V8R: Custom arguments

Type: array of string or string

YAML_V8R: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root YAML_V8R_ARGUMENTS YAML_V8R_ARGUMENTS items
Type: string

root YAML_V8R_CLI_EXECUTABLE

YAML_V8R: CLI Executable

Type: array of string Default: [["v8r"]]

YAML_V8R: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root YAML_V8R_CLI_EXECUTABLE YAML_V8R_CLI_EXECUTABLE items
Type: string

root YAML_V8R_CLI_LINT_MODE

YAML_V8R: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_V8R: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root YAML_V8R_COMMAND_REMOVE_ARGUMENTS

YAML_V8R: Custom remove arguments

Type: array of string or string

YAML_V8R: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root YAML_V8R_COMMAND_REMOVE_ARGUMENTS YAML_V8R_COMMAND_REMOVE_ARGUMENTS items
Type: string

root YAML_V8R_CONFIG_FILE

YAML_V8R: Custom config file name

Type: string Default: ".v8rrc.yml"

YAML_V8R: User custom config file name if different from default

root YAML_V8R_DISABLE_ERRORS

YAML_V8R: Disable errors

Type: boolean Default: false

YAMLV8R: If true, YAMLV8R doesn't make MegaLinter fail even if errors are found

root YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN

YAML_V8R: Maximum number of errors allowed

Type: number Default: 0

YAMLV8R: If the number of errors found is less than this value, YAMLV8R doesn't make MegaLinter fail

root YAML_V8R_FILE_EXTENSIONS

YAML_V8R: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_V8R: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_V8R_FILE_EXTENSIONS YAML_V8R_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root YAML_V8R_FILE_NAMES_REGEX

YAML_V8R: Matching file name regexes

Type: array of string Default: []

YAML_V8R: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_V8R_FILE_NAMES_REGEX YAML_V8R_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root YAML_V8R_FILTER_REGEX_EXCLUDE

YAML_V8R: Excluding Regex

Type: string

YAML_V8R: Custom regex excluding filter: files matching this regex will NOT be linted

root YAML_V8R_FILTER_REGEX_INCLUDE

YAML_V8R: Including Regex

Type: string

YAML_V8R: Custom regex including filter: only files matching this regex will be linted

root YAML_V8R_POST_COMMANDS

YAML_V8R: Post-run commands

Type: array

YAMLV8R: Define bash commands to run after running YAMLV8R

 No Additional Items

Each item of this array must be:

root YAML_V8R_POST_COMMANDS Command

Command

Type: object

Command information

root YAML_V8R_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_V8R_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_V8R_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_V8R_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_V8R_POST_COMMANDS Command output_variables output_variables items
Type: string

root YAML_V8R_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_V8R_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_V8R_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_V8R_PRE_COMMANDS

YAML_V8R: Pre-run commands

Type: array

YAMLV8R: Define bash commands to run before running YAMLV8R

 No Additional Items

Each item of this array must be:

root YAML_V8R_PRE_COMMANDS Command

Command

Type: object

Command information

root YAML_V8R_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_V8R_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_V8R_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_V8R_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_V8R_PRE_COMMANDS Command output_variables output_variables items
Type: string

root YAML_V8R_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_V8R_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_V8R_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_V8R_RULES_PATH

YAML_V8R: Custom config file path

Type: string

YAML_V8R: Path where to find linter configuration file

root YAML_V8R_UNSECURED_ENV_VARIABLES

YAML_V8R: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands

 No Additional Items

Each item of this array must be:

root YAML_V8R_UNSECURED_ENV_VARIABLES YAML_V8R_UNSECURED_ENV_VARIABLES items
Type: string

root YAML_YAMLLINT_ARGUMENTS

YAML_YAMLLINT: Custom arguments

Type: array of string or string

YAML_YAMLLINT: User custom arguments to add in linter CLI call

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_ARGUMENTS YAML_YAMLLINT_ARGUMENTS items
Type: string

root YAML_YAMLLINT_CLI_EXECUTABLE

YAML_YAMLLINT: CLI Executable

Type: array of string Default: [["yamllint"]]

YAML_YAMLLINT: Override CLI executable used to build the linter command line (rarely needed)

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_CLI_EXECUTABLE YAML_YAMLLINT_CLI_EXECUTABLE items
Type: string

root YAML_YAMLLINT_CLI_LINT_MODE

YAML_YAMLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_YAMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

root YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS

YAML_YAMLLINT: Custom remove arguments

Type: array of string or string

YAML_YAMLLINT: User custom arguments to remove before calling linter

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS items
Type: string

root YAML_YAMLLINT_CONFIG_FILE

YAML_YAMLLINT: Custom config file name

Type: string Default: ".yamllint.yml"

YAML_YAMLLINT: User custom config file name if different from default

root YAML_YAMLLINT_DISABLE_ERRORS

YAML_YAMLLINT: Disable errors

Type: boolean Default: false

YAMLYAMLLINT: If true, YAMLYAMLLINT doesn't make MegaLinter fail even if errors are found

root YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN

YAML_YAMLLINT: Maximum number of errors allowed

Type: number Default: 0

YAMLYAMLLINT: If the number of errors found is less than this value, YAMLYAMLLINT doesn't make MegaLinter fail

root YAML_YAMLLINT_FILE_EXTENSIONS

YAML_YAMLLINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_YAMLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_FILE_EXTENSIONS YAML_YAMLLINT_FILE_EXTENSIONS items
Type: string

Examples:

".py"

".myext"

root YAML_YAMLLINT_FILE_NAMES_REGEX

YAML_YAMLLINT: Matching file name regexes

Type: array of string Default: []

YAML_YAMLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_FILE_NAMES_REGEX YAML_YAMLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

"Dockerfile(-.+)?"

"Jenkinsfile"

root YAML_YAMLLINT_FILTER_REGEX_EXCLUDE

YAML_YAMLLINT: Excluding Regex

Type: string

YAML_YAMLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

root YAML_YAMLLINT_FILTER_REGEX_INCLUDE

YAML_YAMLLINT: Including Regex

Type: string

YAML_YAMLLINT: Custom regex including filter: only files matching this regex will be linted

root YAML_YAMLLINT_POST_COMMANDS

YAML_YAMLLINT: Post-run commands

Type: array

YAMLYAMLLINT: Define bash commands to run after running YAMLYAMLLINT

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_POST_COMMANDS Command

Command

Type: object

Command information

root YAML_YAMLLINT_POST_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_YAMLLINT_POST_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_YAMLLINT_POST_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_YAMLLINT_POST_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_POST_COMMANDS Command output_variables output_variables items
Type: string

root YAML_YAMLLINT_POST_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_YAMLLINT_POST_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_YAMLLINT_POST_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "npm run test",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_YAMLLINT_PRE_COMMANDS

YAML_YAMLLINT: Pre-run commands

Type: array

YAMLYAMLLINT: Define bash commands to run before running YAMLYAMLLINT

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_PRE_COMMANDS Command

Command

Type: object

Command information

root YAML_YAMLLINT_PRE_COMMANDS Command command

Bash command to run

Type: string

Enter a bash command. Do not hardcode secret values in the command, as it is not secured
Examples:

"npm run test"

"echo \"This is a custom command\""

root YAML_YAMLLINT_PRE_COMMANDS Command continue_if_failed

Continue if failed

Type: boolean Default: true

If the command fails, continue MegaLinter process

root YAML_YAMLLINT_PRE_COMMANDS Command cwd

Folder where to run the command

Type: enum (of string) Default: "root"

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"

"workspace"

root YAML_YAMLLINT_PRE_COMMANDS Command output_variables

Output ENV variables

Type: array of string

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_PRE_COMMANDS Command output_variables output_variables items
Type: string

root YAML_YAMLLINT_PRE_COMMANDS Command secured_env

Secured ENV variables

Type: boolean Default: true

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

root YAML_YAMLLINT_PRE_COMMANDS Command tag

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"

"before_plugins"

root YAML_YAMLLINT_PRE_COMMANDS Command venv

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.
Example:

"flake8"

Example:

[
    {
        "command": "tflint --init",
        "continue_if_failed": false,
        "cwd": "workspace"
    }
]

root YAML_YAMLLINT_RULES_PATH

YAML_YAMLLINT: Custom config file path

Type: string

YAML_YAMLLINT: Path where to find linter configuration file

root YAML_YAMLLINT_UNSECURED_ENV_VARIABLES

YAML_YAMLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands

 No Additional Items

Each item of this array must be:

root YAML_YAMLLINT_UNSECURED_ENV_VARIABLES YAML_YAMLLINT_UNSECURED_ENV_VARIABLES items
Type: string